DRAFT PROPOSAL FOR COMMENTS

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

Overview

Scope

What is this release trying to address?

1. Update project-level documentation for Beijing Release requirements

2. Improving the Usability of the Platform:
   
   

   • Establish consistent tool chain and guidelines for API documentation

   • Create Welcome to ONAP and "sandbox" functionality for novices to ONAP

   • Automate verification process in the CI/CD Documentation tool chain

   • 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

Use Cases

The documentation created by this project must support ONAP high level Beijing use cases.

Lower level use cases specific to documentation project scope include:

1. Publish a finished set of formal change-controlled documentation for any user audience working with the ONAP Beijing release.

2. Establish a consistent method for documenting APIs

3. Create welcoming documentation and a place to play for novices to ONAP

4. Create a way for users to provide feedback
   
   
   

Minimum Viable Product

Final documentation for ONAP Beijing 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

Stories

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.

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.

Architecture

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.

Indicate where your project fit within the ONAP Archiecture diagram.

Block and sequence diagrams showing relation within the project as well as relation with external components are expected.

Anyone reading this section should have a good understanding of all the interacting modules.

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:

• ONAP gerrit project repositories,

• doc project repository master document index.rst, templates, configuration, and other documents

• submodules directory where other project repositories and directories/files are referenced

• file structure: directories (ellipses), files(boxes)

• references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)

Platform Maturity

Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.

• API Incoming Dependencies

List the API this project is expecting from other projects.
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 Outgoing Dependencies

API this project is delivering to other projects.

• 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, ...).

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.

• KNOWN DEFECTS AND ISSUES

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

• 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).

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

• 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

  • ...

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.