...
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Enter the name of the release you are targeting to deliverAmsterdam |
| Project Lifecycle State | Either Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
| Participating Company List the company participating in this release. At least 3-4 organizations, including an operator are recommended. | AT&T, Amdocs, Huawei, Nokia, China Mobile, ZTE |
Scope
What is this release trying to address?
Describe the problem being solved by this release
Use Cases
...
- 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
Describe the MVP for this release.Final documentation for ONAP Release 1 Use Cases
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.
...
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox doc and issuetype in (epic) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox doc and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
| Deliverable Name | Deliverable Description | To fill out | To fill out|
|---|---|---|---|
| doc/index.rst | Master index for all documentation in an ONAP Release | ||
| doc/tools/* | Scripts used to collect, compose, validate source documentation material and publish final form documentation | ||
| doc/<source directories> | Source directories and sub-directories as needed to
|
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
...
List the other ONAP projects your depends on.
- 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
...
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...