...
- 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 Automate verification process in the CI/CD Documentation 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
- 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 feedbackCross-project Integration / Views
Minimum Viable Product
Final documentation for ONAP Beijing Use Cases
...
Jira server ONAP JIRA columns summary,type,created,updated,due,reporter,priority,status maximumIssues 20 jqlQuery Project = Doc and type = EPIC and status = Open serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
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
| ||
| Beijing Project-level Updates | Published release documentation for all Beijing projects | ||
| Stretch Goals (Level 2) | Deliverable Description | ||
| Content Initiatives |
| ||
| Tool Chain Initiatives |
| 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.
Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
...
| 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 | Recruit resources as needed | Adjust scope & deliverables accordingly | 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.
Release Milestone
The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.
...