Honolulu Release Planning for docs

Owned by Sofia Wallin
Last updated: Jan 28, 2021
2 min read


Overview

Project Name

Enter the name of the project

Project Name

Enter the name of the project

Target Release Name

Honolulu

Project Lifecycle State

Core

Participating Company 

Ericsson Software Technology, Deutsche Telekom, Orange, Nokia

Scope

What is this release trying to address?

General/maintenance project tasks:

  • Support in producing composite documentation for ONAP releases

  • Define guidelines and tooling for documentation handling across all ONAP projects

  • Support project to understand requirements throughout the release cycle

Release specifics tasks:

  • Documentation process 

    • minimum scope for participating projects (planning, reviews, branching etc) 

  • Getting started with your documentation

    • Suggestion to schedule a session for the upcoming virtual event

  • Cleaning up outdated content

    • Continuously clean up out dated content from RTD. How to do this in a structured way?

  • Enable a voting job -1 for warnings (te be excluded long line) 

  • API Documentation handling

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 type created updated due assignee reporter priority status resolution
Refresh

Stories

key summary type created updated due assignee reporter priority status resolution
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, etc) of this release.

Deliverable Name

Deliverable Description

Deliverable Name

Deliverable Description

Release documentation 

Ensure that the project delivers documentation according to expectations

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

Platform Maturity

Please fill out the centralized wiki page: Frankfurt Release Platform Maturity

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.

  • DOCUMENTATION, TRAINING

Please update the following centralized wiki: Frankfurt Documentation

That includes

  • Team contributions to the specific document related to he project (Config guide, installation guide...).

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