This page lists all documentation-related projects that have been proposed as part of the Beijing release
| Initiative | Description | Priority | Project Owner(s) | Doc Liaison(s) | JIRA EPIC |
|---|---|---|---|---|---|
| Beijing Project-level Updates | Creating or updating project-level documentation for Release 2 | Required | All Projects | All Liaisons | DOC-197 - Getting issue details... STATUS |
| NEW CONTENT INITIATIVES | |||||
| API's |
2. Differentiate:
| Higher | All Projects with APIs | DOC-217 - Getting issue details... STATUS | |
| "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. "ONAP Light" Documentation - Put each step into context, both what and why One example is Istio's Concepts page: https://istio.io/docs/concepts/ | Higher | Project Leads | DOC-215 - Getting issue details... STATUS | |
| Wiki for novices | Different audiences: "ONAP Light" version (non-coding) targeted for SEs, architects on how to use the platform
"Sandbox" targeted for developers to actually interact with the code Issues: | Higher | Integration? Helen Chen ? | DOC-216 - Getting issue details... STATUS | |
| VNF Reference list | Documentation and ongoing repository for integration tested VNFs (i.e. certified by ONAP for third party providers) Issue: where should it go - include i.e. ONAP.org | Higher | DOC-28 - Getting issue details... STATUS | ||
Migrate Seed Documentation from Wiki | General Migration Process / Issues | Anuj Kapoor | DOC-21 - Getting issue details... STATUS | ||
| Setting Up ONAP | Higher | ||||
| Integrating with ONAP | Higher | Integration OpenStack (Dave Neary, Red Hat) | |||
| Using ONAP | Higher | Documentation / SDC, Policy, CLAMP, VID | Gregory Glover | ||
| Architecture | Higher | Architecture / All Projects | |||
| Documenting ONAP | Higher | Documentation | |||
| Developing ONAP | Higher | All Projects | |||
| 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). | Lower | Lisa Caywood | DOC-214 - Getting issue details... STATUS | |
| Glossary | Migrate Wiki content to RsT and expand content to include: - VNF Information Modeling terms - Indexing / tagging to enable Searching | Lower | Modeling Architecture | DOC-218 - Getting issue details... STATUS | |
| NEW TOOL CHAIN INITIATIVES | |||||
Automation/Verification
|
| Higher | LF Amar Kapadia ? | DOC-8 - Getting issue details... STATUS | |
| Feedback Capabilities | RTD Feedback
Wiki Feedback
| Higher | LF Amar Kapadia ? | DOC-222 - Getting issue details... STATUS | |
| LF Tool Chain Documentation | How to:
| Lower | LF Thanh Ha | DOC-220 - Getting issue details... STATUS | |
| PROCESS ISSUES | DOC-221 - Getting issue details... STATUS | ||||
| 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 Gildas Lanilis | |||
| 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 | Lisa Caywood | Gregory Glover | ||
| Wiki vs Readthedocs | How to best communicate guidelines on what content should be where | Thanh Ha | Gregory Glover |