This is a working wiki to capture the ONAP architecture component descriptions

ONAP Components Architecture Reviews Guidelines (work in progress)

The focus of the component reviews is to ensure that the documentations provided in these wiki pages are consistent with what the state of each ONAP component for a specific release.

The component documentations/diagrams listed above have been scrubbed and cleaned up to the extent possible.. the following is a list of guidelines to you prepare for your review:

1. The "Attachment" folder associated with each Component (... in upper right corner) has also been cleaned up and all draft copies of the diagrams have bee deleted.
2. draw.io is the tool currently used to draw all the diagrams
3. Each component diagram file has the following format:
   1. componentName_r7 (i.e. sdnc_r7 for the SDN Controller)
   2. The .png file associated eith your component gets generated by draw.io
   3. there may be other files/images left in the Attachement folder. feel free to modify/delete any file(s) to reflect the changes  associated with the release
   4. the draw.io diagrams (i.e. lollipop diagram) is based on the C4 Model for visualizing Software Architecture?? - Please maintain the same format as you make any changes to your respective component
   5. each diagram has a release stamp (bottom left corner) that should not be modified
   6. Each API (consumed or offered) is depicted by a lollipop and a label;y ou may add, modify or delete any API' as needed but please maintain the same loo and feel and the diagram file naming convention

the emphasis wail be on documenting the component APIs,  whether consumed or offered, and to provide as much detail and clarity on the the what and the how of each API. with that in mind i'd like to propose the following as a starting point for conducting these reviews:

1. I would like for  each PTL  to be responsible for their respective component

ONAP component descriptions for the Guilin-R7 Release

ONAP Components Architecture Reviews Tracking Matrix for the Guilin-R7 Release

A template for the component description can be found here.

The main topics to cover are:

-

-

Instructions:

• Include the latest powerpoint slides as an attatchment to the component description page.  This way we can always retrieve it to update the visual contents.
• Include the description and figures in the page as well.