...
What is this release trying to address?
Describe the problem being solved by this release
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
Minimum Viable Product
- Establish for ONAP a best practice CI/CD tool chain and processes for managing ONAP documentation
- Establish templates, guides, examples, relationships to release planning and integration projects that will make documentation an integral easy to perform activity for all projects contributing to an ONAP software release.
- Create documentation required by ONAP Release 1 use cases
- Migrate seed documentation currently in the wiki or gerrit that is being maintained by approved projects
Use Cases
The new documentation created by this project must support ONAP high level Amsterdam use cases.
Lower level use cases specific to documentation project scope include:
- Store documentation source in gerrit project repositories in a form that is easy for multiple authors to create and maintain.
- Define and integrate source from multiple repository locations into an complete, organized set for an ONAP release.
- Automatically (re)create a complete set of finished documentation whenever any sources change.
- Publish the finished set of documentation in where it can be easily referenced by any user audience that is working with an ONAP release.
Minimum Viable Product
Final documentation for ONAP Release 1 Use CasesDescribe the MVP for this release.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
...
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description | To fill out | To fill outDescription | |
|---|---|---|---|---|
| doc | Source Repository with a master index for all documentation in an ONAP Release in TBD( .rst, .md, or other) format. | |||
| doc/tools | Scripts used to collect, compose, validate source documentation material and publish final form documentation | |||
| doc/source/<repository> | Repositories as needed to
| |||
| TBD (onap.readthedocs.io, nexus.onap.org raw site) | Published release documentation |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
...
Anyone reading this section should have a good understanding of all the interacting modules.Gliffy Diagram name DOC Architecture for M1
The diagram below illustrates what is accomplished in the setup steps above from the perspective of a file structure created for a local test, a jenkins verify job, and/or published release documentation including:
- ONAP gerrit project repositories,
- doc project repository master document index.rst, templates, configuration, and other documents
- submodules directory where other project repositories and directories/files are referenced
- file structure: directories (ellipses), files(boxes)
- references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)
Platform Maturity
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
...
| Risk identified | Mitigation Plan | Contingency Plan | ||
|---|---|---|---|---|
| Scope of release requirements | Complete and Interlock on Release Index | To fill out | To fill out | To fill out|
| Availability of contributors | Create/Link JIRA Contribution Stories to | |||
| Alignment on the Minimum Viable Tool Chain | Create early, partial content, end to end example |
Resources
Fill out the Resources Committed to the Release centralized page.
...