Doc Work Plan for Beijing (Release 2)

Creating or updating project-level documentation for Release 2

Interfaces

API - Structure & Tool Chain

• Use of Swagger (required)
  Define best way to represent/visualize - RsT may not be best?
• Containers
• Kubernetes

René Robert

Eric Debeau

API - Differentiation

• REST APIs
• HealthCheck APIs
• Components APIs (eg Java class API)

OpenStack Interfaces

Strategic view of where and why OpenStack API's are used in ONAP, interface definitions and expectations; AI&I, DCAE (gathering information from the platform), Multi-VIM, APP-C, and SDN-C (asking the platform to do things/put itself in a certain state).

ONAP for Newcomers

"Welcome to ONAP" Flows and Text

Convert existing component level diagrams to high level flows and text. Include high level Architecture, as well as as typical use cases such as:  VNF Onboarding, Fault management, and Capacity management.

One example is Istio's Concepts page: https://istio.io/docs/concepts/

Project Leads

ONAP "Light" for novices

ONAP "Light" version (non-coding) targeted for SEs, architects on how to use the platform

1. Install ONAP on their local cloud environment
2. Run Health Check
3. Run three Use cases:  vFW, vDNS, vCPE

Documentation - Put each step into context, both what and why 

Wiki "Sandbox"

"Sandbox" for developers to actually interact with the code

• Install on laptops, pre-configured environment
• Allow for coding, build and compile
• Default IDEs
• Does not impact live Master Branch
• Available for hackathon
  
  

VNF Reference list

Documentation and ongoing repository for integration tested VNFs (i.e. certified by ONAP for third party providers)

• Integration Team provides list of reference VNFs
• Need to establish template 
  
  

Future:  Establish VNF "App Store" (VNF SDK project drives ?)

Doc Tool Chain / Utilities

Automation/Verification

• Doc8+/- Coala Code Policies
• Spelling
• Grammar
• Editorial / Usability
• Sphinx directives
• Integrity of Glossary/Info Model
• Integrity of sphinx toctree
• Integrity of external references
• Acceptable file types
• CI/CD repo integration

Dev Edit RST File - Unit Test - Gerrit - Code Review/Verify Job - Gerrit Human Review - Daily CSIT - Release Integration Test

RTD Feedback

• JIRA project to report an error
• Wiki or stack overflow Q&A
• Simple, more accessible link tool for editing RTD pages

Wiki Feedback
Establish new structure and process for:

•     Discussion forum
•     Submitting suggestions / feedback with existing content

LF Tool Chain Documentation

•     Gerrit guide
•     Guidelines (Builds, etc.)
•     Utilities:  Jenkins, Conversion tools (e.g. LF Pandocs)

Specify how and when to branch Beijing

Provide clear dates to expectations to PTLs - goal is to finalize Beijing more quickly than it took for Amsterdam

How and when to document:

1. Certified VNFs (when that happens)

2. Certified Platform elements