In case you would need to :
- Fulfill the Akraino Project TSC requirement to perform a review of your Documentation,
- Need assistance related to your Documentation and/or selected topics related to your Documentation
- Inquire about available Documentation/Literature related to your BPs utilized Technologies
please be so kind to follow the following instructions (procedure):
- Prepare a Structure under your BP that refelects the needed Documentation Templates (1. API, 2. Architecure, 3. Installation, 4. Test, 5.Releases) by creating a catalogue that denominates the Documentation purpose (e.g. Akraino Rel 5 Documentation) and under the Catalogue, please filled in all required Templates.
2. Once yo are ready for conducting the review, please be notified that Akraino Documentation Sub-committee has dedicated 2 x30min slots each Friday at 07:00am PST. Please book 1
(one) of the 2 ( two) Time slots by logging in to Akraino Documentation Sub-committee and indicating:
2.1 Date and Time of the Slot: e.g. Friday, June 9th, at 07:00 - 07:30 . In case you consider that 30min would not be enough, please book both slots by placing a Remark that you book 2
(2) slots.
2.2. Add (write) the title of the BP,
2.3 PTL name and
2.4 Add the link to the Catalogue on Akraino wiki where all the filled in Documentation templates are stored and ready for review
3. Send a written request to: documentation@lists.akraino.org . Addind as Cc the Documentatio Sub-Committee Chair, Documentation Co-Chair as well as the Akraino TSC Chair and Co-Chair is optional. You can add as Cc to your mail request for Documentation Review selected individuals in case that you would like these individuals to help and assist you through monitoring/following your request to inform/notify Documentation Sub-committee Chair and/or Co-chair in case that your mail is not read.
4. Please await for a Reply-confirmation from Documentation Sub-committee that your Request is been received and accepted and the Date- and Time for Documentation review is noted.
5. After performing Documentation review, under your booking for Documentation Review, the outcome of the review will be conveyed in written as a recommendation to the TSC whether to deem your Documentation as accepted or not. The comments and remarks during the Review, will also be mentioned as part of the forwarded to the Akraino TSC recommendation.