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 Index Issues/Tasks |
|---|---|---|---|---|---|
| CONTENT-RELATED | |||||
| Beijing Content Updates | Work related to creating or updating documentation for Release 2 | Higher | All Projects | All Liaisons | |
| API's |
2. Differentiate:
| Higher | All Projects with APIs | René Robert | |
| Welcome to ONAP Flows and Text | Convert existing component level diagrams to high level flows and text. Include VNF Onboarding, Fault management, and Capacity management. One example is Istio's Concepts page: https://istio.io/docs/concepts/ | Higher | Project Leads | ||
| Wiki "Sandbox" for novices | Create higher level sandbox for developers, SEs, architects to see E2E system / Cross component interactions Issues: How complete does the Wiki version need to be? Blocked by need for continuous deployment servers | Higher | Integration? Helen Chen ? | ||
| VNF Reference | Documentation structure for tested VNFs Issue: where should it go - include i.e. ONAP.org | Higher | VVP Steven Wright ONAP Marketing | ||
Migrate Wiki Documentation | General Migration Issues | DOC-63 - Getting issue details... STATUS | |||
| Setting Up ONAP | Higher | ||||
| Integrating with ONAP | Higher | Integration Helen Chen ? | |||
| Using ONAP | Higher | Documentation / SDC, Policy, CLAMP, VID | Gregory Glover | ||
| Architecture - Minor edits / table conversion | 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 | OpenStack (Dave Neary, Red Hat)? Multi-VIM xinhuili | Lisa Caywood | |
| Restructure / Clean Up existing content | Restructure / Remap existing content to Developer and SDK templates | Lower | |||
| Glossary | Migrate Wiki content to RsT and expand content to include: - VNF Information Modeling terms - Indexing / tagging to enable Searching | Lower | Modeling / Architecture | DOC-154 - Getting issue details... STATUS | |
| UTILITIES / TOOLS | |||||
Automation/Verification
|
| Higher | LF Amar Kapadia ? / Documentation | ||
| RTD Lifecycle Feedback | • JIRA project to report an error • Wiki or stack overflow Q&A | Higher | LF Amar Kapadia ? / Documentation | ||
Wiki Feedback | Establishing new structure and process for:
| Higher | LF (Lisa Caywood)? | ||
| RTD Edit Tool | Simple, more accessible link tool for making changes on RTD pages | Lower | Documentation | ||
| LF Tooling / Utilities | How to:
| Lower | LF Thanh Ha | DOC-201 - 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 | 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 | Communicate guidelines on what content should be where | Thanh Ha | Gregory Glover |