DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
...
| Deliverable Name | Deliverable Description |
|---|---|
| doc/index.rstMaster | 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/<source directories>Source directories and sub-directories <repository> | Repositories as needed to align with the overall documentation index
|
Sub-Components
...
| |
| TBD (onap.readthedocs.io, nexus.onap.org raw site) | Published release documentation |
Sub-Components
All components are described as source deliverables above and/or will be identified by:
- inclusion in the master index with a reference to another project repository/index file and link from a JIRA story for the other projects to the DOC project story
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key DOC-17
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
...
- ci-management
- Any project that contains a portion of the documentation source referenced in final documentation set.
- A documentation publishing site (eg. readthedocs.io, Nexus raw site)
Architecture
Sections below to be provided after tool chain comparison/discussion
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
...
| Gliffy | ||||||
|---|---|---|---|---|---|---|
|
API Incoming Dependencies
List the API this release is expecting from other releases.T
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| To fill out | High level description of the APITBD | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description |
...
| 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.
...