Image Added

The Documentation Sub-committee objective is to promote a consistent documentation structure and quality assurance across both the Akraino Project level and all individual Blueprint Families. It also serves the Akraino TSC requirements to follow the Akraino Procedures aiming Quanlity Quality assurance process and perform the required Documentation review.

About procedure to place a request for a Documentation review, please read/follow the instructions listed under Documentation Sub-committee Sub-catalogue titled "How to Request a Documentation review?

For further detailed information related to Documentation Sub-committee procedures and templates, you can look at the following sub-catalogues:

How to Request a Documentation Review?

Akraino Blueprint API Template

Akraino Blueprint Architecture Template

Akraino Blueprint Datasheet template

Akraino Blueprint Installation Guide Template

Akraino Blueprint Release Notes Template

Akraino Blueprint Test Template

Please join the Documentation Sub-Committee mail list by self-adding within the Akraino Mail List Sub-Groups page. 

...

Documentation sub-committee members(From Nov 2023~): 

We have started the process to elect a new chair for the Documentation sub-committee.  The process started on 23 Nov and will continue until Noon 15 Dec 2023 (Pacific)  

The election process is two steps.  The first is for people to self-nominate for the position.  To do this, put a Y in the correct column if you wish to run for Chair.  The second step is to have an election for the position.  If there is only one person who has self nominated, then that person will be chair.  

Note: Please ensure that both the name and email address for each member is listed on each sub-committee membership wiki page in order to properly set up CIVS voting when required. 

Interested parties sign up:

Documentation sub-committee members(From Nov 2020~Nov 2023): 

Note: Election Nov 5 2020- Unfortunately Samir has notified the TSC that he will not be able to continue as Chair.  Thus we are opening up the self-nomination process.  Please put a Y in the Self-nomination column if you wish to be chair.  If not, please put an N.  This process will go until Noon on 12 Nov (Pacific time).  If there is only one self nominee then that person will become chair.  If there are two or more, we will have an election. 

...

• In the API document. There is not an explicit reference to Open API Specification (OAS https://spec.openapis.org/oas/v3.1.0) and if the API structure follows it. In the Architecure Document, there is justa title "Open API. In case that BP follows OAS, it is recommended to explicitly state that in the BP's API Document. The API document is thorough. It is follows any Architecture Standard API structure, it is recommended to also explicitly refere to it.
• In the Architecure Document, there is used the abbrerviation MEC. As "MEC" abbreviation is used by the ETSI MEC and respective Standard Solution Architecture, in case that the BluePrint follows the ETSI MEC Architecture Standard Specification, then it is recommended to use its complete denomination (ETSI MEC). If not, it is recommended not to use the abbreviation MEC, but its full name. The presented Architecture figures present the call flow based on Kubernetes (K3S Light and K8S). There is lack of indication of used interfaces and protocols. Therein, the respective presentation is just a "Diagram" rather than an "Architecure". It is recommended to indicate respective "Protocls" and "Interfaces" to indicate connections and/or dependencies. With regard to AI, there is harldy any information. It is recomended to add information about the utlized ML Algorithms, Type of Models and Models Training Approach, used Data Granularity and Charactristics for Training models, How the "test case data" is treated with regard to CNN RLU (to start with).
• Installation Document is thorough and detailed. It is recommended to update with a Section related to ML (AI) Data handling/treatment and New Data gathering, Storage, Update and use for ML Model build-up and Algorithm(s) training.
• Related to "Release" Document, it is recommended to provide the BP's Roadmap with respective Releases (Features, Functionalities, Dependancies, Security and Time Table) and with respect to that refer to what is new related to Akraino Rel. 4. It is impossible to understand how the Solution/Product/Platform is planned to be evolved.
• On the Security Test Document, it is preferable for the Akraino TSC to receive the Akraino Security Sub-committee assessment analysis.

Attached below 5G General Performance Requirements for Video Production Applications & Airborne Base Stations for NPN (Non Public Network)

Image Added  Image Added

Assessment summary and Recommendation to Akraino TSC: Overall assessment is that the BP's Documentation for Akraino Rel 4 is well prepared and thorough for each Part. There is a good overview on the overall Solution and related UCs. Therein, it is recommended to the Akraino TSC to deem the BP's Rel. 4 Documentation as accepted.

...

View file
name DMTF Redfish Specification Jan 2021.pdf height 250

      

View file
name DMTF Redfish Scalable Platforms Management API Specification Aug 2018.pdf height 250

Release 2 Final Documentation and Milestone Review

...