...
- Update project-level documentation for Beijing Release requirements
- Improving the Usability of the Platform:
- Establish consistent tool chain and standards guidelines for API documentation
- Create introductory documentation Welcome to ONAP and "sandbox" functionality for novices to ONAP
- Refine and harden the CI/CD tool chain and processes initially established in Amsterdam
- Migrate seed documentation currently in the wiki or gerrit that is being maintained by approved projects
- Refine / expand current documentation for VNFs, OpenStack interfaces, UIs, and LF Tool Chain
- Establish feedback mechanisms in Wiki and/or Readthedocs to improve documentation
...
- Publish a finished set of formal change-controlled documentation where it can be easily referenced by for any user audience that is working with the ONAP Beijing release.
- Novices
- Cross-project Integration / Views Establish a consistent method for documenting APIs
- Create welcoming documentation and a place to play for novices to ONAP
- Create a way for users to provide feedback
Minimum Viable Product
Final documentation for ONAP Beijing Use Cases
...
Jira Legacy server System Jira columns summary,type,created,updated,due,reporter,priority,status maximumIssues 20 jqlQuery Project = Doc and type = EPIC and status = Open serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Required (Level 1) | Deliverable Description |
|---|---|
| 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 |
| Beijing Project-level Updates | Published release documentation for all Beijing projects |
| Stretch Goals (Level 2) | Deliverable Description |
| Content Initiatives |
|
| Tool Chain Initiatives |
|
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
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:
...
| Risk identified | Mitigation Plan | Contingency Plan | ||
|---|---|---|---|---|
| Scope of release requirements | Complete and Interlock on Release Index | 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.
...