Beijing (Release 2) Doc Work Plan
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
| Phasing / Prioritization - what's ready now
| Required | All Projects | |
Interfaces | API - Structure & Tool Chain
| High | @Andy Mayer @Former user (Deleted) @Dana Bobko @Rene ROBERT | ||
API - Differentiation
| High | @Rene ROBERT @Eric Debeau | |||
OpenStack Interfaces Strategic view of where and why OpenStack API's are used in ONAP, interface definitions and expectations; AA&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). | On hold - Dave Neary moved to new role Multi-VIM owner going foward? | Medium | Multi-VIM @Former user (Deleted) OOM @David S | https://lf-onap.atlassian.net/browse/DOC-202https://lf-onap.atlassian.net/browse/DOC-211 | |
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/ | Onboarding Documentation needed (Pawel):
Populate remaining generic flows (Gil) Architecture sub-team including E2E views? (Chris D) | High | @Paweł Pawlak @Gil Bullard @Rich Bennett @RAMANJANEYUL AKULA | |
ONAP "Light" for SEs, Architects 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 | @Eric Debeau | |||
Wiki "Sandbox" "Sandbox" for developers to actually interact with the code
Documentation; Need tutorial materials (videos, text, flows?) | Victor: Technically possible to point the vagrant-onap tool to an existing OpenStack Deployment [1]. Vagrant-onap tool has helped us to collect some disperse bash instructions in a single place. No feedback yet from PTLs or developers about the missing pieces except for SDC. This tool has been suffered many changes lately and I haven’t been able to test all of them so maybe it’s just matter to do few adjustments.
| 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 ?) | Template established in RtD (Steven / Rich) Two ways to differentiate:
| Higher | VVP: @Steven wright Imre Egei | |
List of tested VNFs through Beijing | Coordinate population of VNF templates (Helen) | Higher | Integration @Helen Chen | ||
How / where to publish | Publish in RTD under "Use Cases" | Higher | LF @Lisa Caywood ? | ||
Migrate Seed Documentation from Wiki | Migration Process / Issues | @Anuj Kapoor | |||
Setting Up ONAP | Higher | @Eric Debeau ? | |||
Integrating with ONAP | Higher | @Dave Neary (Deactivated) Integration @Helen Chen | |||
Using ONAP | Higher | SDC, Policy, CLAMP, VID @gg2147@att.com | |||
Architecture | Higher | Architecture / All Projects | |||
Documenting ONAP | Higher | @gg2147@att.com | |||
Developing ONAP | Higher | All Projects | |||
Glossary | Low | Modeling, Architecture | |||
ONAP Health & Maturity | Daily / Frequent Health Tests |
| Medium | Integration @Helen Chen @Sastry Isukapalli | |
Maturity |
| Medium | Integration @Helen Chen | ||
URL | Medium | LF | |||
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 | @Rich Bennett LF @Amar Kapadia ? | ||
RTD Feedback
| Medium | @Rich Bennett ? LF @Amar Kapadia ? | |||
Wiki Feedback
| Medium | @Rich Bennett ? LF @Amar Kapadia ? @Lisa Caywood ? | |||
LF Tool Chain Documentation
| 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 | @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 | How to best communicate guidelines on what content should be where | |