Versions Compared

Version Old Version 21 New Version 22
Changes made by

gg2147@att.com

gg2147@att.com

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page lists all documentation-related projects that have been proposed as part of the Beijing release

InitiativeDescriptionPriorityProject Owner(s)Doc Liaison(s)
JIRA  Index Issues/Tasks
JIRA EPICJIRA  Issue(s)
CONTENT-RELATED





Beijing Content Updates
Work related to creating

Creating or updating project-level documentation for Release 2

  		HigherAll ProjectsAll Liaisons

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-197


API's
  1. Define consistent Structure and Tool Chain   

2. Differentiate:

  • REST APIs
  • HealthCheck APIs
  • Components APIs (eg Java class API)
HigherAll Projects with APIsRené Robert

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-217


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/

Higher

Project Leads


Lisa Caywood ?

Paweł Pawlak ?

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-215


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 servers		Higher

Integration? Helen Chen ?

Eric Debeau ?

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-216


VNF Reference

Documentation structure for tested VNFs

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

Higher

VVP Steven wright

ONAP Marketing

Lisa Caywood

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-28



Migrate Wiki Documentation




General Migration Issues


Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-21

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-63

Setting Up ONAPHigher



Integrating with ONAPHigher

Integration Helen Chen ?




Using ONAPHigherDocumentation / SDC, Policy, CLAMP, VIDgg2147@att.com

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-172
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-179

Architecture - Minor edits / table conversionHigherArchitecture / All Projects


Documenting ONAPHigherDocumentation


Developing ONAPHigherAll Projects


OpenStack 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).Lower

OpenStack (Dave Neary, Red Hat)?

Multi-VIM Former user (Deleted)
Lisa Caywood

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-

202

214

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-

211Restructure / Clean Up existing content Restructure / Remap existing content to Developer and SDK templates  Lower

202

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-
148
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-105
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-94
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-2
211
GlossaryMigrate Wiki content to RsT and expand content to include:
-  VNF Information Modeling terms
-  Indexing / tagging to enable Searching		LowerModeling / Architecture

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-

154UTILITIES / TOOLS

218

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-154








TOOL CHAIN






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
Higher

LF Amar Kapadia ? /

Documentation

Rich Bennett ?


Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-160
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-81

Feedback Capabilities

RTD

Lifecycle

Feedback

•
  • JIRA project to report an error
•
  • Wiki or stack overflow Q&A
Higher

LF Amar Kapadia ? /

Documentation

Rich Bennett ?

  • Simple, more accessible link tool for editing RTD pages


Wiki Feedback

Establishing

Establish new structure and process for:

  •     Discussion forum
  •     Submitting suggestions / feedback with existing content
Higher

LF

(

Amar Kapadia ?

Lisa Caywood

)LF Tooling / Utilities

?

Rich Bennett ?

RTD Edit Tool

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

LowerDocumentation


LF Tool Chain Documentation

How to:

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

Rich Bennett ?


Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-201








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