Documentation

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
- a Service Provider using VNF Requirements as prototype text for RFPs to acquire VNFs to run in an ONAP context
- ... 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 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.

Describe the functionality to be provided by the project.
- Documentation artifacts for ONAP integrating dependencies on source material from all projects
- CI/CD Documentation Tool Chain
  - The tool chain to develop the documentation artifacts is expected to be similar to the tool chain used to develop the code artifacts.
  - There may be linkages within the tool chains - e.g. to propagate changes in APIs into the documentation.
Please provide the full intended scope of the project; not just what is intended for the project's first release.
- First release establishes best practices and basic documentation.
- Subsequent releases will be required for all projects to comply with practices, complete content for all audiences, address how documents might be tailored or translated for use in different ONAP instances, etc.
Identity a list of features and functionality will be developed.
- Documentation managed with the same pattern as source code including gerrit, jenkins, artifacts published in nexus or readthedocs.org, etc.
- output documentation format TBD - likely wiki and .pdf versions required with hyperlinks between the different documents as appropriate..
- depending on the volume of documentation, some indexing/ search capabilities may be required.
Identify what is in or out of scope. During the development phase, it helps reduce discussion.
- TBD

How does this project fit into the rest of the ONAP Architecture?
- Dependencies with all projects providing source material for documentation.
  - Code changes may drive documentation changes.
  - Some documentation e.g. VNF Requirements may need to be traceable to code modules (e.g. test cases)
- Target use cases drive the user audience and task requirements.
How does this align with external standards/specifications?
- Project will identify best practices for a documentation tool chain by looking at other open source projects (eg. open daylight, opnfv)
Are there dependencies with other open source projects?
- Evaluate use of readthedocs.org as way of publishing documents.
- Evaluate the use of swagger.io for API documentation

Key Project Facts

Project Name:

Repo names:

Lifecycle State: proposal
Primary Contact:
Project Lead:
mailing list tag [docs]
Committers:
rb2745@att.com
timo.perala@nokia.com
gg2147@att.com
ks0567@att.com

*Link to TSC approval:
Link to approval of additional submitters: