Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Project NameEnter the name of the project
Target Release NameEnter the name of the release you are targeting to deliverBeijing
Project Lifecycle StateEither 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, Orange, ZTE, Accenture

Scope

What is this release trying to address?

  • Update project-level documentation for Beijing Release requirements
  • Establish consistent Establish for ONAP a best practice CI/CD tool chain and processes standards 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.
  • API documentation
  • Create introductory documentation and "sandbox" functionality for novices to ONAP
  • Refine and harden the CI/CD tool chain and processes initially established in AmsterdamCreate documentation required by ONAP Release 1 use cases
  • 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 new documentation created by this project must support ONAP high level Amsterdam Beijing use cases.

Lower level use cases specific to documentation project scope include:

...

Final documentation for ONAP Release 1 2 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.

...

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

Gliffy Diagram
nameDOC Architecture for M1

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:

...