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 Release Content | Work related to creating or updating documentation for Release 2 | High | All Projects | All Liaisons | |
| API's |
2. Differentiate:
| High | All Projects with APIs | René Robert | |
| 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 (Dave Neary, Red Hat)? Multi-VIM Former user (Deleted) | ||
| 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/ | High | 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 | High | Integration? Helen Chen ? | ||
| VNF Reference | Documentation structure for tested VNFs Issue: where should it go - include i.e. ONAP.org | High | VVP Steven wright ONAP Marketing | ||
Migrate Wiki Documentation | General Migration Issues | DOC-63 - Getting issue details... STATUS | |||
| Setting Up ONAP | High | ||||
| Integrating with ONAP | Medium | Integration Helen Chen ? | |||
| Using ONAP | High | Documentation / SDC, Policy, CLAMP, VID | gg2147@att.com | ||
| 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 | |
| Restructure / Clean Up 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 | DOC-154 - Getting issue details... STATUS | |
| UTILITIES / TOOLS | |||||
Automation/Verification
|
| Medium | LF Amar Kapadia ? / Documentation | ||
| RTD Lifecycle Feedback | • JIRA project to report an error • Wiki or stack overflow Q&A | Medium | LF Amar Kapadia ? / Documentation | ||
Wiki Feedback | Establishing new structure and process for:
| Low | LF (Lisa Caywood)? | ||
| RTD Edit Tool | Simple, more accessible link tool for making changes on RTD pages | Low | Documentation | ||
| LF Tooling / Utilities | How to:
| Low | 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 Gmail | |||
| 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 | gg2147@att.com | ||
| Wiki vs Readthedocs | Communicate guidelines on what content should be where | Thanh Ha | gg2147@att.com |