Page Comparison

4733707d-2057-3a0f-ae5e-4fd8aff50176

Initiative	Description	Priority	Project Owner(s)	Doc Liaison(s)	JIRA  Index Issues/Tasks
CONTENT-RELATED
Beijing Release Content Updates	Work related to creating or updating documentation for Release 2	HighHigher	All Projects	All Liaisons
API's	Define consistent Structure and Tool Chain    2. Differentiate: REST APIs HealthCheck APIs Components APIs (eg Java class API)	HighHigher	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)	Lisa Caywood ?
Jira Legacy
server	System Jira
serverId
key	DOC-202

Jira Legacy
server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key DOC-211

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/

HighHigher

Project Leads

Wiki "Sandbox" for novicesCreate 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 serversHighHigher
VNF Reference

Documentation structure for tested VNFs

Issue:  where should it go - include i.e. ONAP.org

HighHigher

General Migration Issues


Setting Up ONAPHighHigher


Integrating with ONAPMediumHigher

Using ONAPHighHigherDocumentation / SDC, Policy, CLAMP, VIDgg2147@att.comArchitecture - Minor edits / table conversionMediumHigherArchitecture / All Projects

Documenting ONAPMediumHigherDocumentation

Developing ONAPHighHigherAll ProjectsExternal Installation OptionsInstallation / 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…MediumONAP.org

Lisa CaywoodOpenStack InterfacesStrategic 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).LowerLisa CaywoodRestructure / Clean Up existing content Restructure / Remap existing content to Developer and SDK templates  LowLower

GlossaryMigrate Wiki content to RsT and expand content to include:
-  VNF Information Modeling terms
-  Indexing / tagging to enable SearchingLowLowerModeling / Architecture






UTILITIES / TOOLS

Automation/Verification

• Doc8+/- Coala Code Policies
• Spelling
• Grammar
• Editorial / Usability
• Sphinx directives
• Integrity of Glossary/Info Model
• Integrity of sphinx toctree
• Integrity of external references
• Acceptable file types
• CI/CD repo integration

1. Dev Edit RST File
2. Unit Test
3. Gerrit - Code Review/Verify Job
4. Gerrit - Human Review
5. Daily CSIT
6. Release Integration Test

MediumHigherRTD Lifecycle Feedback

• JIRA project to report an error

• Wiki or stack overflow Q&A

MediumHigher

Wiki Feedback

Establishing new structure and process for:

•     Discussion forum
•     Submitting suggestions / feedback with existing content

LowHigher

RTD Edit Tool

Simple, more accessible link tool for making changes on RTD pages

LowLowerDocumentation

LF Tooling / Utilities

How to:

•     Gerrit guide
•     Guidelines (Builds, etc.)
•     Utilities:  Jenkins, Conversion tools (e.g. LF Pandocs)

LowLowerLF 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 Gmail

VNF Certification

How and when to document:

1. Certified VNFs (when that happens)

2. Certified Platform elements

VVP

VideosManaging and tracking what and where videos are being posted
Lisa Caywoodgg2147@att.com
Wiki vs ReadthedocsCommunicate guidelines on what content should be where
Thanh Hagg2147@att.com