...
- Describe the functionality to be provided by the project
- Curate/Edit/Organize Documentation - provided by committers and contributors to documentation project for each ONAP release including
- Identifying the documentation required for a release based on an end to end view of targeted user audiences, tasks requirements, use cases, input from ONAP committees (architecture, marketing, etc) and approved projects.
- Reviewing projects, release plans, and committee artifacts early in a release to align on end to end platform terminology and where draft documentation is provided in the release plan
- Creating/Maintaining a top level index for all documentation in an ONAP release (org.onap.doc repository).
- Creating/Maintaining sub-repositories below org.onap.doc/sources for projects and committees that provide documentation source material. Committer ACLs on sub-repositories may supplement or override the inherited org.onap.doc committer ACL to align control of the sub-repository with other projects providing the source material.
- Providing consistent terminology and style guides for contributors.
- Write Documentation - provided by contributors to this project or other sources
- Create documentation source material that references other project provided source material and adds information tailored to a particular user audience and task.
- Documentation CI/CD Tool Chain - committers and contributors to the doc project create and/or configure tools that automatically generate release documentation from all sources
- Gerrit, Jenkins job builder configured to build documentation any time a top level or lower in the doc repository hierarchy change. A successful build will trigger an update at Readthedocs.
- Gerrit, Jenkins job builder configured to build documentation any time a top level or lower in the doc repository hierarchy change. A successful build will trigger an update at Readthedocs.
- Curate/Edit/Organize Documentation - provided by committers and contributors to documentation project for each ONAP release including
- Specify any interface/API specifications proposed
- Sphinx and ReStructuredText will be used for index structure and source document contents.
- TBD other tools for auto generated or documentation embedded in source code (Swagger, Javadocs, etc.)
...