...
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 |
| ||||||||||||||||||||||||
NEW CONTENT INITIATIVES | |||||||||||||||||||||||||||||
Interfaces | API - Structure & Tool Chain
| API's |
| High | All Projects with APIs | ||||||||||||||||||||||||
API - Differentiation2. Differentiate:
| HigherHigh | All App Projects with APIs | 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). | Medium | Lisa Caywood | |||||||||||||||||||||||||||
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. "ONAP Light" Documentation - Put each step into context, both what and why "Sandbox": Need tutorial materials (videos, text, flows?). One example is Istio's Concepts page: https://istio.io/docs/concepts/ | HigherHigh | Project Leads | ||||||||||||||||||||||||||
ONAP JIRA | |||||||||||||||||||||||||||||
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb | ||||||||||||||||||||||||||||
key | DOC-215 | HigherHigh | |||||||||||||||||||||||||||
Wiki "Sandbox" "Sandbox" for developers to actually interact with the code
| High | Victor Morales (lead) Helen Chen (support) | |||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||
Migrate Seed Documentation from Wiki | General Migration Process / Issues | Anuj Kapoor |
| ||||||||||||||||||||||||||
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 ProjectsOpenStack 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 |
| Glossary | Migrate Wiki content to RsT and expand content to include: - VNF Information Modeling terms - Indexing / tagging to enable Searching | Lower | Modeling Architecture |
| ||||||||||||||||||
Glossary | Low | Modeling, Architecture | |||||||||||||||||||||||||||
NEW TOOL CHAIN INITIATIVES | |||||||||||||||||||||||||||||
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 | LF Amar Kapadia ? |
| |||||||||||||||||||||||||
RTD Feedback
| Medium | LF Amar Kapadia ? | |||||||||||||||||||||||||||
Wiki Feedback
| HigherMedium | LF Amar Kapadia ? | |||||||||||||||||||||||||||
LF Tool Chain Documentation How to:
| Lower | LF Thanh Ha | |||||||||||||||||||||||||||
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 | How to best communicate guidelines on what content should be where | Thanh Ha | Gregory Glover |