This page lists all documentation-related projects that have been proposed as part of the Beijing release
| Project Name | Description | Priority | Project Owner(s) | Doc Liaison(s) | JIRA Index Issues/Tasks | |
|---|---|---|---|---|---|---|
| CONTENT-RELATED | ||||||
| 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). | High | OpenStack / TBD | TBD | ||
| Flow Diagrams | Converting to text existing flow diagrams describing each component and where the hand-offs happen, including corresponding videos. Include VNF onboarding, Fault management, Capacity management. Istio's Concepts page breaks down high level concepts https://istio.io/ | High | Project Leads | |||
| Wiki "Sandbox" for newbies | 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 | High | Integration? Helen Chen ? | |||
| VNF Reference | List of tested ONAP VNFs (where should it go - include ONAP.org) | High | Integration? Helen Chen ? | |||
| Wiki Conversion & Migration | Setting Up ONAP | High | ||||
| Integrating with ONAP | Medium | Integration Helen Chen ? | ||||
| Using ONAP | High | Documentation / SDC, Policy, CLAMP, VID | Gregory Glover | |||
| Architecture - Minor edits / table conversion | Medium | Architecture / All Projects | ||||
| Documenting ONAP | Medium | Documentation | ||||
| Developing ONAP | High | All Projects | ||||
| External Installation Options | Installation / Lab options provided by: - Vendors (to be listed via request to mailing list) - Linux Foundation (if any available solution is ready) - ONAP Community (e.g. Orange OpenLab should be open soon, also Eric set up individual VM on Orange public cloud for APPC or SDNC to let people play with the DG, API… | Medium | ONAP.org | Lisa Caywood | ||
| API's | Differentiate: - REST APIs - HealthCheck APIs - Components APIs (eg Java class API) | Medium | All Projects | |||
| Restructure existing content | Restructure / Remap existing content to Developer and SDK templates | Low | ||||
| Glossary | Migrate Wiki content to RsT and expand content to include: - VNF Information Modeling terms - Indexing / tagging to enable Searching | Low | Modeling / Architecture | |||
| UTILITIES / TOOLS | ||||||
Automation/Verification
|
| |||||
| RTD Feedback | • JIRA project to report an error • Wiki or stack overflow Q&A and/or | Medium | Documentation | |||
Wiki Feedback | Establishing new structure and process for:
| Low | LF (Lisa Caywood)? | |||
| RTD Edit Tool | Simple, more accessible tool for making changes on pages | Low | Documentation | |||
| LF Tooling / Utilities | How to:
| Low | LF | |||
| PROCESS ISSUES | ||||||
| Branching Guidelines | How and when to branch | 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 | |||