Versions Compared

Old Version 33

changes.mady.by.user Gregory Glover

Saved on

compared with

New Version 34

changes.mady.by.user Gregory Glover

Saved on

Key

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

...

DOC-217

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 

server

OpenStack (Dave Neary, Red Hat)

Multi-VIM user-40485serverId

DOC-220

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







NEW CONTENT INITIATIVES









Interfaces

API - Structure & Tool Chain

  • Use of Swagger (required)
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
HighAll Projects with APIs

René Robert

Eric Debeau


API - Differentiation2. Differentiate:

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

René

Robert

ROBERT

Eric Debeau

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

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

Medium

OpenStack (Dave Neary, Red Hat)


Multi-VIM lixinh
Lisa Caywood










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.

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

HigherHigh

Project Leads


Lisa Caywood ?

Pawel Pawlak ?

Jira
server


ONAP

JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDOC-215
HigherHigh
Eric Debeau
Jira
ONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
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?)		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)

  • 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

Template: Steven Wright

Publishing: LF Lisa Caywood ?

Lisa Caywood

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






Migrate Seed Documentation from Wiki




General Migration Process / Issues

Anuj Kapoor

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

Setting Up ONAPHigher

Eric Debeau ?


Integrating with ONAPHigher

Integration

OpenStack (Dave Neary, Red Hat)



Using ONAPHigherDocumentation / SDC, Policy, CLAMP, VIDGregory Glover
ArchitectureHigherArchitecture / All Projects

Documenting ONAPHigherDocumentation

Gregory Glover


Developing ONAPHigherAll ProjectsOpenStack 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 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		Lower

Modeling

Architecture

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



GlossaryLowModeling, Architecture







NEW TOOL CHAIN INITIATIVES
















Doc Tool Chain / Utilities



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

Dev Edit RST File

- Unit Test

- Gerrit - Code Review/Verify Job

- Gerrit

-

Human Review

- Daily CSIT

- Release Integration Test

Higher

LF Amar Kapadia ?

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
Medium

LF Amar Kapadia ?

Lisa Caywood ?

Rich Bennett ?


Wiki Feedback
Establish new structure and process for:

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

LF Amar Kapadia ?

Lisa Caywood ?

Rich Bennett ?

Jira
serverONAP JIRA
425b2b0a-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
key








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

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 CaywoodGregory Glover
Wiki vs ReadthedocsHow to best communicate guidelines on what content should be where
Thanh HaGregory Glover