Versions Compared

Version Old Version 32 New Version 33
Changes made by

gg2147@att.com

gg2147@att.com

Saved on

Key

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

...

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

Creating or updating project-level documentation for Release 2

  		RequiredAll ProjectsAll Liaisons

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







NEW CONTENT INITIATIVES




API's
  1. Define consistent Structure and Tool Chain , including: 
  • Swagger required
    Define best way to represent/visualize - RsT may not be best?
  • Containers
  • Kubernetes

2. Differentiate:

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

René Robert

Eric Debeau

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 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/

Higher

Project Leads


Lisa Caywood ?

Paweł Pawlak ?

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

ONAP "Light" for novices

ONAP "Light" version (non-coding) targeted for SEs, architects on how to use the platform

  1. Install ONAP on their local cloud environment
  2. Run Health Check
  3. Run three Use cases:  vFW, vDNS, vCPE

Documentation - Put each step into context, both what and why 

Higher
Eric Debeau


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

Wiki "Sandbox"

"Sandbox" for developers to actually interact with the code

  • Install on laptops, pre-configured environment
  • Allow for coding, build and compile
  • Default IDEs
  • Does not impact live Master Branch
  • Available for hackathon

Documentation;  Need tutorial materials (videos, text, flows?)

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)

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

HigherLead

  • Integration Team provides list of reference VNFs
  • Need to establish template 

Future:  Establish VNF "App Store" (VNF SDK project drives ?)

Higher

List:  Integration Helen Chen

GuidelinesTemplate: VVP  Steven wright

Publishing: ONAP Marketing LF Lisa Caywood ?

Lisa Caywood

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


Migrate Seed Documentation from Wiki




General Migration Process / Issues

Anuj Kapoor

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

Setting Up ONAPHigher

Eric Debeau ?


Integrating with ONAPHigher

Integration

OpenStack (Dave Neary, Red Hat)



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

Documenting ONAPHigherDocumentation

gg2147@att.com


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-214

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

Modeling

Architecture


Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
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 ?

Rich Bennett

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
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 Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
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 Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyDOC-220







PROCESS ISSUES



Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
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 Gmail

Rich Bennett 


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 ReadthedocsHow to best communicate guidelines on what content should be where
Thanh Hagg2147@att.com