This page lists all documentation-related projects that have been proposed as part of the Beijing release
| Initiative | Description | Status / Meeting Notes | Priority | Project Lead(s) | JIRA Issue(s) |
|---|---|---|---|---|---|
Beijing Project-level Updates
| Creating or updating project-level documentation for Release 2 | Required | All Projects | DOC-197 - Getting issue details... STATUS | |
Interfaces
| API - Structure & Tool Chain
| High | DOC-227 - Getting issue details... STATUS | ||
API - Differentiation
| High | DOC-200 - Getting issue details... STATUS | |||
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 | DOC-224 - Getting issue details... STATUS | ||
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 | DOC-225 - Getting issue details... STATUS | |||
Wiki "Sandbox" "Sandbox" for developers to actually interact with the code
| High | Victor Morales (lead) Helen Chen (support) | DOC-226 - Getting issue details... STATUS | ||
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 | DOC-231 - Getting issue details... STATUS | |
| List of tested VNFs through Beijing | Higher | Integration Helen Chen | DOC-232 - Getting issue details... STATUS | ||
| How to where to publish | Higher | LF Lisa Caywood ? | DOC-233 - Getting issue details... STATUS | ||
Migrate Seed Documentation from Wiki | Migration Process / Issues | Anuj Kapoor | DOC-179 - Getting issue details... STATUS | ||
| Setting Up ONAP | Higher | ||||
| Integrating with ONAP | Higher | Integration Helen Chen | |||
| Using ONAP | Higher | SDC, Policy, CLAMP, VID | |||
| Architecture | Higher | Architecture / All Projects | |||
| Documenting ONAP | Higher | ||||
| 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 | DOC-234 - Getting issue details... STATUS | ||
RTD Feedback
| Medium | DOC-228 - Getting issue details... STATUS | |||
Wiki Feedback
| Medium | DOC-230 - Getting issue details... STATUS | |||
LF Tool Chain Documentation
| Lower | LF Thanh Ha | DOC-229 - Getting issue details... STATUS | ||
| 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 | DOC-235 - Getting issue details... STATUS | |||
| VNF Certification | How and when to document: 1. Certified VNFs (when that happens) 2. Certified Platform elements | VVP | DOC-236 - Getting issue details... STATUS | ||
| Videos | Managing and tracking what and where videos are being posted | DOC-237 - Getting issue details... STATUS | |||
| Wiki vs Readthedocs | How to best communicate guidelines on what content should be where | DOC-238 - Getting issue details... STATUS |
