...
- Create and maintain documentation targeted to ONAP user audiences and the tasks they perform. For example:
- a platform developer pulling, building, running, hacking and pushing source code;
- an administrator installing, configuring, and monitoring an ONAP instance;
- a designer or tester creating, validating, and delivering service models;
- a VNF developer designing, testing, and certifying a VNF for use on ONAP
- ... others as required for release plans or ONAP committees
- Establish and maintain a tool chain that supports the integration of documentation source material from all ONAP projects and builds documentation artifacts for each release.
- Establish a process to recognize source and final documentation dependencies in the release plan, end to end tests, and/or CI/CD to insure these deliverables are created early in a release cycle and remain current with changes in made in other projects.
- Benefits include users quickly understand how to do required tasks, documentation is efficiently created and is in sync with the software in a release.
...
- Seed Code -
- API Guides - MSO, AAI, APPC, Policy, Portal
- Schema - AAI
- Guidelines - VNF Guidelines for Network Cloud, VNF Management Requirements, VNF Cloud Readiness, ONAP Logging
- Developer User Guides -
- Developer APPC
- Service Designer - Design, Deploy, SDC
- Administrator - ONAP Portal for administrators
- Operations - Operate, VID, Policy application, DMaaP Bus Controller, ONAP Portal for users
- Tutorials - Installing and Running the ONAP Demos, Automatically Creating a Netconf Mount in APPC from SDNC
- Vendor Neutral Yes
- Meets Board policy (including IPR) Yes
...