...
- Proposed name for the project:
Documentationdocs - Proposed name for the repository:
org.onap.docs
Project description:.
- Create and maintain documentation for targeted to ONAP for 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 the the a tool chain that supports the integration of sources to build ONAP release documentationdocumentation source material from all ONAP projects and builds documentation artifacts for each release.
- Establish a process recognized to recognize source and final documentation dependencies in the release plan whereby some sources of documentation are maintained by other projects. For example, an API document for a software component or guidelines document for VNF developer.
- Determine how to align content with training, marketing, etc
- Determine how to validate documentation
- , 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 Benefit end users quickly understand how to do somethingrequired tasks, documentation is always efficiently created and is in sync with the software in a release.
Scope:
- Describe the functionality to be provided by the project.
- Complete Content CatalogDocumentation Catalog for ONAP and dependencies on source material from all projects
- CI/CD Document Tool Chain
- Please provide the full intended scope of the project; not just what is intended for the project's first release.
- First release establishes good practices and basic documentation.
- Subsequent release releases will be required for all projects to comply with practices, complete content , understand / meet multi-language requirements, etcfor all audiences, address how documents might be tailored or translated for use in different ONAP instances.
- Identity a list of features and functionality will be developed.
- Documentation uses managed with a similar the same pattern source code including gerrit, jenkins, artifacts published in nexus or readthedocs.org, etc.
- Identify what is in or out of scope. During the development phase, it helps reduce discussion.
- TBD
- TBD
Architecture Alignment:
- How does this project fit into the rest of the ONAP Architecture?
- Linkages Dependencies with source project providers code projects insure alignment.
- Target users and use cases drive the contentuser audience and task requirements.
- How does this align with external standards/specifications?
- Identify best practices for documentation tool chain talking with other open source projects (eg. open daylight, opnfv)
- Are there dependencies with other open source projects?
- May Evaluate use readthedocs.org as way of publishing documents.
...
- JIRA project name: Documentation
- JIRA project prefix: DOC
Repo namenames:
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
...