Skip to end of metadata
Go to start of metadata

The content of this template is expected to be fill out for M1 Release Planning Milestone.

Info

Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much diagrams and flow charts as you need, directly in the wiki, to convey your message.


Overview

Project NameEnter the name of the project
Target Release NameAmsterdam
Project Lifecycle StateIncubation
Participating Company AT&T, Amdocs, Huawei, Nokia, China Mobile, ZTE, Accenture

Scope

What is this release trying to address?

  • 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:

  1. Store documentation source in gerrit project  repositories in a form that is easy for multiple authors to create and maintain.
  2. Define and integrate source from multiple repository locations into an complete, organized set for an ONAP release.
  3. Automatically (re)create a complete set of finished documentation whenever any sources change.
  4. 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 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.

Epics

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh


Longer term roadmap

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

Release Deliverables

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

Deliverable NameDeliverable Description
doc

Source Repository with a master index for all documentation in an ONAP Release in TBD( .rst, .md, or other) format.
Each index file may contain source content and references to other index files within the doc repo directory structure, other repositories with the doc project (eg. doc/source/userguide), and/or other project repositories.

doc/toolsScripts used to collect, compose, validate source documentation material and publish final form documentation
doc/source/<repository>

Repositories as needed to

  • store content that integrates documentation across the platform and/or focuses on users audiences and tasks that a software project does not need to be aware of (eg. a task that uses multiple software components)
  • reflect different committer expertise and responsibility for a class of documentation (eg. guide for a developer, user, operations)
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  DOC-17 - Getting issue details... STATUS

Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.

ONAP Dependencies

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

High level architecture diagram

DOC Architecture for M1

API Incoming Dependencies

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.

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outTBDDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description

API Outgoing Dependencies

API this release is delivering to other releases.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description

Third Party Products Dependencies

Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).

NameDescriptionVersion
To fill outTo fill outTo fill out

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

Testing and Integration Plans

Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.

Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.

Gaps

This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.

Gaps identifiedImpact
To fill outTo fill out

Known Defects and Issues

Provide a link toward the list of all known project bugs.

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Risks

List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).

Risk identifiedMitigation PlanContingency Plan
Scope of release requirements

Complete and Interlock on Release Index

DOC-16 - Getting issue details... STATUS

To fill out
Availability of contributors

Create/Link JIRA Contribution Stories to
DOC-17 - Getting issue details... STATUS


Alignment on the Minimum Viable Tool Chain

Create early, partial content, end to end  example
DOC-8 - Getting issue details... STATUS


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.

Team Internal Milestone

This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is erecommended to provide these agreements and dates in this section.

It is not expected to have a detailed project plan.

DateProjectDeliverable
To fill outTo fill outTo fill out

Documentation, Training

  • Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
  • Highlight the team contributions to the overall Release Documentation and training asset
  • High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
  • Documentation includes items such as:
    • Installation instructions
    • Configuration instructions
    • Developer guide
    • End User guide
    • Admin guide
    • ...

Note

The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.


Other Information

Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.

Free and Open Source Software

FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.

Each project must edit its project table available at Project FOSS.


Charter Compliance

The project team comply with the ONAP Charter.