...
- Describe the functionality to be provided by the project.
- Curator/Editor Functionality provided by committers and contributors to this project for each ONAP release.
- Identify the documentation required for a release based on targeted user audiences, tasks requirements, use cases, input from ONAP committees (architecture, marketing, etc) and projects.
- Create a top level index for all documentation required for an ONAP release in the org.onap.docs repository.
- Identify sources and create sub-repositories below org.onap.docs for projects and committees that provide documentation source material. Committer ACLs on sub-repository may supplement or override the inherited org.onap.docs ACLs to align control with projects providing the source material.
- Review project, planning, integration, and committee artifacts or source material early in a releases release looking for opportunities to align on clear end to end terminology and to test early drafts of documentation.
- CI/CD Functionality provided by the tools created and/or configured by this project are triggered by a change in a source repository that the documentation depends on.
- Gerrit, Jenkins job builder will be configured for each release to generate a new documentation any time the top level or lower in the docs repository hierarchy change. A successful build will trigger an update at Readthedocs.
- Gerrit, Jenkins job builder will be configured for each release to generate a new documentation any time the top level or lower in the docs repository hierarchy change. A successful build will trigger an update at Readthedocs.
- Curator/Editor Functionality provided by committers and contributors to this project for each ONAP release.
- Specify any interface/API specifications proposed
- Sphinx and ReStructuredText will be used for index structure and source document contents that are built from gerrit repositories and updated at Readthedocs.
...