...
Initiative | Description | Status / Meeting Notes | Priority | Project OwnerLead(s) | Doc Liaison(s) | JIRA Issue(s) | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Beijing Project-level Updates | Creating or updating project-level documentation for Release 2 | Required | All ProjectsAll Liaisons |
| |||||||||||||||
Interfaces | API - Structure & Tool Chain
|
| HighAll Projects with APIs |
| |||||||||||||||
API - Differentiation
| High | App Projects with APIs |
| ||||||||||||||||
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). | Medium |
| |||||||||||||||||
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/ | High Project Leads |
| ||||||||||||||||
ONAP "Light" for novices ONAP "Light" version (non-coding) targeted for SEs, architects on how to use the platform
Documentation - Put each step into context, both what and why | High |
| |||||||||||||||||
Wiki "Sandbox" "Sandbox" for developers to actually interact with the code
| High | Victor Morales (lead) Helen Chen (support) |
| ||||||||||||||||
VNF Reference list | Documentation and ongoing repository for integration tested VNFs (i.e. certified by ONAP for third party providers)
Future: Establish VNF "App Store" (VNF SDK project drives ?) | Higher | VVP: Steven Wright |
| |||||||||||||||
List of tested VNFs through Beijing | Higher | Integration Helen Chen |
| ||||||||||||||||
How to where to publish | Higher | LF Lisa Caywood ? |
| ||||||||||||||||
Migrate Seed Documentation from Wiki | Migration Process / Issues | Anuj Kapoor |
| ||||||||||||||||
Setting Up ONAP | Higher | ||||||||||||||||||
Integrating with ONAP | Higher | ||||||||||||||||||
Using ONAP | Higher | Documentation / SDC, Policy, CLAMP, VID | |||||||||||||||||
Architecture | Higher | Architecture / All Projects | |||||||||||||||||
Documenting ONAP | HigherDocumentation | ||||||||||||||||||
Developing ONAP | Higher | All Projects | |||||||||||||||||
Glossary | Low | Modeling, Architecture | |||||||||||||||||
Doc Tool Chain / Utilities | Automation/Verification
Dev Edit RST File - Unit Test - Gerrit - Code Review/Verify Job - Gerrit Human Review - Daily CSIT - Release Integration Test | Higher |
| ||||||||||||||||
RTD Feedback
| Medium |
| |||||||||||||||||
Wiki Feedback
| Medium |
| |||||||||||||||||
LF Tool Chain Documentation
| Lower | LF Thanh Ha |
| ||||||||||||||||
PROCESS ISSUES | |||||||||||||||||||
Branching Guidelines | 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 | Release Manager |
| ||||||||||||||||
VNF Certification | How and when to document: 1. Certified VNFs (when that happens) 2. Certified Platform elements | VVP |
| ||||||||||||||||
Videos | Managing and tracking what and where videos are being posted |
| |||||||||||||||||
Wiki vs Readthedocs | How to best communicate guidelines on what content should be where |
|