Versions Compared

Old Version 25

changes.mady.by.user Gregory Glover

Saved on

compared with

New Version 26

changes.mady.by.user Gregory Glover

Saved on

Key

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

...

InitiativeDescriptionPriorityProject Owner(s)Doc Liaison(s)JIRA EPIC
CONTENT-RELATEDBeijing Content Beijing Project-level Updates

Creating or updating project-level documentation for Release 2

  		HigherRequiredAll ProjectsAll Liaisons

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-197







NEW CONTENT INITIATIVES




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
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
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 ?

Pawel Pawlak ?

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
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
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
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
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-28


Migrate Seed Documentation from Wiki Documentation




General Migration Issues


Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-21

Setting Up ONAPHigher


Integrating with ONAPHigher

Integration Helen Chen ?



Using ONAPHigherDocumentation / SDC, Policy, CLAMP, VIDGregory Glover
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 xinhuili
Lisa Caywood

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-214

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

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-218







NEW TOOL CHAIN INITIATIVES





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
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-8

Feedback Capabilities

RTD Feedback

  • JIRA project to report an error
  • Wiki or stack overflow Q&A
  • Simple, more accessible link tool for editing RTD pages


Wiki Feedback
Establish new structure and process for:

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

LF Amar Kapadia ?

Lisa Caywood ?

Rich Bennett ?

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-222

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
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-220







PROCESS ISSUES



Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-221

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

VideosManaging and tracking what and where videos are being posted
Lisa CaywoodGregory Glover
Wiki vs ReadthedocsCommunicate guidelines on what content should be where
Thanh HaGregory Glover