You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 64 Next »

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

InitiativeDescriptionStatus / Meeting NotesPriorityProject Lead(s)JIRA Issue(s)

Beijing Project-level Updates


Creating or updating project-level documentation for Release 2

  
Required

All Projects


DOC-197 - Getting issue details... STATUS












Interfaces


API - Structure & Tool Chain

  • Use of Swagger (required)
    Define best way to represent/visualize - RsT may not be best?
  • Containers
  • Kubernetes

Tara:  Got referral to OData.  On the surface, this seems like a valid approach for ONAP to work with because the ONAP APIs seem close to the OData standard.  If that's true this would be a way for getting ONAP apis to conform to the OpenAPI/swagger spec.  Is this worth pursuing?

ONAP API Guidelines 2-02-2018.pptm

High

René Robert

Eric Debeau

Tara Cummings

DOC-227 - Getting issue details... STATUS

API - Differentiation

  • REST APIs
  • HealthCheck APIs
  • Components APIs (eg Java class API)


High

René ROBERT

Eric Debeau

DOC-200 - Getting issue details... STATUS

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

Dave Neary

Lisa Caywood

Multi-VIM lixinh

DOC-202 - Getting issue details... STATUS DOC-211 - Getting issue details... STATUS










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.


One example is Istio's Concepts page: https://istio.io/docs/concepts/

High

Paweł Pawlak 

Gil Bullard

Rich Bennett

DOC-224 - Getting issue details... STATUS

ONAP "Light" for SEs, Architects

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 


High

Eric Debeau

DOC-225 - Getting issue details... STATUS

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:  Technically possible to point the vagrant-onap tool to an existing OpenStack Deployment [1].  Vagrant-onap tool has helped us to collect some disperse bash instructions in a single place. No feedback yet from PTLs or developers about the missing pieces except for SDC. This tool has been suffered many changes lately and I haven’t been able to test all of them so maybe it’s just matter to do few adjustments.

  • Need OpenStack deployment (Windriver?)
  • Functionality limited to single component(s)
  • Users download from Integration folder


[1] http://onap.readthedocs.io/en/latest/submodules/integration.git/bootstrap/vagrant-onap/doc/source/features/openstack.html

High

Victor Morales (lead)

Helen Chen (support)

DOC-226 - Getting issue details... STATUS





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

Two ways to differentiate:

  1. Commercial vs Open Source
    Pointers to doc in both cases
  2. HEAT vs. TOSCA - examples from each
    HEAT:  vFW, vDNS, vCPE (vCPE breaks down further)
    TOSCA: VoLTE (breaks down further)


Start with vDNS? - good for community input

Higher

VVP: Steven Wright

DOC-231 - Getting issue details... STATUS

List of tested VNFs through Beijing
Higher

Integration Helen Chen

DOC-232 - Getting issue details... STATUS

How / where to publishPublish in RTD under "Use Cases"Higher

LF Lisa Caywood ?

DOC-233 - Getting issue details... STATUS






Migrate Seed Documentation from Wiki




Migration Process / Issues

Anuj Kapoor

DOC-179 - Getting issue details... STATUS

Setting Up ONAP
Higher

Eric Debeau ?


Integrating with ONAP
Higher

Dave Neary

Integration Helen Chen


Using ONAP
Higher

SDC, Policy, CLAMP, VID

Gregory Glover


Architecture
HigherArchitecture / All Projects
Documenting ONAP
Higher

Gregory Glover


Developing ONAP
HigherAll Projects
Glossary
LowModeling, Architecture




ONAP Health & Maturity


Image result for tempurature gauges clip art black and white

Daily / Frequent Health Tests
  1. Daily health test results deployed by OOM and Heat
  2. Daily test results for vFW / vLB / vCPE
  3. Nexus tags for above two tests results: repo and docker images (for people to easily get a stable ONAP code in their local env.)
Medium

Integration Helen Chen


Maturity
  1. Granularity
  • E2E
  • Project level

    2. Maturity requirement: performance, resilience, etc.  
    3. Different tools: JProfile, Chaos Monkey, etc.
Medium

Integration Helen Chen


URLtestresults.onap.org      MediumLF

















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

Rich Bennett

LF Amar Kapadia ?

DOC-234 - Getting issue details... STATUS

RTD Feedback

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

Medium

Rich Bennett ?

LF Amar Kapadia ?

Lisa Caywood ?

DOC-228 - Getting issue details... STATUS

Wiki Feedback
Establish new structure and process for:

  •     Discussion forum
  •     Submitting suggestions / feedback with existing content

Medium

Rich Bennett ?

LF Amar Kapadia ?

Lisa Caywood ?

DOC-230 - Getting issue details... STATUS

LF Tool Chain Documentation

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

Lower

LF Thanh Ha

DOC-229 - Getting issue details... STATUS







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



Gildas Lanilis


DOC-235 - Getting issue details... STATUS

VNF Certification

How and when to document:

1. Certified VNFs (when that happens)

2. Certified Platform elements



VVP

DOC-236 - Getting issue details... STATUS

VideosManaging and tracking what and where videos are being posted

Lisa Caywood

Gregory Glover

DOC-237 - Getting issue details... STATUS

Wiki vs ReadthedocsHow to best communicate guidelines on what content should be where


Thanh Ha

Gregory Glover

DOC-238 - Getting issue details... STATUS

  • No labels