...
At a high level ONAP is a complex architecture with a myriad of interdependencies and relationships between ONAP's components, other open source projects and industry standard organizations. For an engineer wanting more information on ONAP one One of the first things they often do is up a new user may is look at the architecture diagram and then go searching for the appropriate documentation set in relationship to itthe picture. The feed back we've received from new users is that actually finding the correct documentation is often time consuming and confusing. Making the correct documentation easier to find is the, "mutually agreed upon need" part .previously mentioned
ONAP documentation takes on 2 forms. First (and the most problematic) is our development documentation on https://wiki.onap.org/ which . This is highly uncontrolled tends to get and gets obsolete rapidly. The second and more important part is the official documentation at https://docs.onap.org/ which is all curated content. The latter is the realm of ONAP's Documentation project, a hard working group of folks that are responsible for defining the guidelines and tooling for documentation handling across all ONAP projects. The They also help ensure that when we cut a new release the documentation is in the best possible state. They don't write the documentation per-se, but they make sure that the structure, look and feel and similar things are aligned and as complete as possible.
ONAP's Architecture Subcommittee also works across all of our projects. This group spends most of its time evaluating is focused on how the technical pierces of ONAP all fit work together and align. The ONAP Architecture Navigator (ArchNav for short) is a web based Proof of Concept (PoC) developed by Subcommittee for the purpose of quickly popping around areas of ONAP documentation via the architecture diagram for specific to each release. This allows people to find information in a manner that is based upon a visual representation driven rather than being of the architecture itself rather than being a more menu driven model.
The time has come to transition ArchNav out of the lab an into a production environment for the Architecture Subcommittee. This is a pretty straight forward technical effort for anyone with the "Must Have" skills listed below.
...