...
- Describe the functionality to be provided by the project.
- Documentation artifacts for ONAP release that contain
- original content created by the documentation project and
- integrate source material from any project that the documentation depends to be consistent with an ONAP release.
- CI/CD Documentation Tool Chain
- The tool chain to create document artifacts will include gerrit, jenkins, and nexus the same as software projects and add specific tools appropriate for documentation.
- Where there are published documentation depends on source in a repository, the tool chain will support the integration 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.
- Documentation artifacts for ONAP release that contain
- 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 pattern for managed documentation as well as the documentation for ONAP release 1.
- 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.
- Training is not part of this project
- 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 Output documentation format TBD - likely wiki static html and .pdf versions required with hyperlinks between the different documents as appropriate..
- depending Depending on the volume of documentation, some indexing/ search capabilities may be requiredprovided.
- Identify what is in or out of scope. During the development phase, it helps reduce discussion.
- In scope - Best practice tool chain and pattern for creating documentation, Release 1 documentation.TBD
- In scope - Best practice tool chain and pattern for creating documentation, Release 1 documentation.TBD
Architecture Alignment:
- 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.
- Dependencies with all projects providing source material for documentation.
- 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
...