This page lists all documentation-related projects that have been proposed as part of the Beijing release
Initiative | Description | Status / Meeting Notes | Priority | Project |
---|
OwnerDoc LiaisonJIRA Index Issues/Tasks | CONTENT-RELATED | Beijing Release Content | Updated Content for all approved Beijing projects | High | All Projects | |
---|
Beijing Project-level Updates Image Added
| Creating or updating project-level documentation for Release 2 | Phasing / Prioritization - what's ready now
- New content for Beijing - create checklist ?
- Review recent content additions / JIRA doc board for any updates
- For OOM / every Run-Time component - should we capture HELM charts and Values / Resources, including latest installation guidelines
| Required | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-197 |
---|
|
|
|
|
|
|
|
|
---|
Interfaces Image Added
| API - Structure & Tool Chain - Use of Swagger spec
Define best way to represent/visualize - RsT may not be best? - Containers
- Kubernetes
| | High | | View file |
---|
name | ONAP API Recommendations-draft 6 April-2018.pptm |
---|
height | 250 |
---|
|
View file |
---|
name | ONAP API Recommendations-draft 6 April-2018.pptm |
---|
height | 250 |
---|
|
Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-227 |
---|
|
|
API - Differentiation - REST APIs
- HealthCheck APIs
- Components APIs (eg Java class API)
|
| High | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-200 |
---|
|
|
All Liaisons |
OpenStack Interfaces Strategic view of where and why OpenStack API's are used in ONAP, interface definitions and expectations; |
AIAA&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). |
High | OpenStack ? Multi-VIM xinhuili | | | Flow Diagrams | Converting to text existing flow diagrams describing each component and where the hand-offs happen, including corresponding videos. Include VNF onboarding, Fault management, Capacity management. Istio's Concepts page as an exampleHigh | Project Leads Red Hat (Dave Neary) ? | | Wiki "Sandbox" for newbies | Create 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 | High | Integration? Helen Chen ? | | VNF Reference | List of tested ONAP VNFs (where should it go - include ONAP.org) | High | VVP Steven Wright ONAP Marketing | | Wiki Conversion & MigrationSetting Up ONAP | High | Integrating with ONAP | Medium | | Using ONAP | High | Documentation / On hold - Dave Neary moved to new role Multi-VIM owner going foward?
| Medium | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-202 |
---|
|
Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-211 |
---|
|
|
Image Added | "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/ |
| View file |
---|
name | vFW Use Case – Working Notes.pptx |
---|
height | 150 |
---|
|
Onboarding Documentation needed (Pawel): - Types of licenses: universal, unique and one time
- License term: fixed term, perpetual, unlimited
- Onboarding procedure: manual or network package
- How to delete objects created (i.e. VSP)?
Populate remaining generic flows (Gil) Architecture sub-team including E2E views? (Chris D) | High | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-224 |
---|
|
|
ONAP "Light" for SEs, Architects ONAP "Light" version (non-coding) targeted for SEs, architects on how to use the platform - Install ONAP on their local cloud environment
- Run Health Check
- Run three Use cases: vFW, vDNS, vCPE
Documentation - Put each step into context, both what and why | View file |
---|
name | ONAP-Newbies (002).pptx |
---|
height | 150 |
---|
|
| High | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-225 |
---|
|
|
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 | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-226 |
---|
|
|
VNF Reference list Image Added
| 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 ?) | Template established in RtD (Steven / Rich) Two ways to differentiate: - Commercial vs Open Source
Pointers to doc in both cases - 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 Imre Egei | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-231 |
---|
|
|
List of tested VNFs through Beijing | Coordinate population of VNF templates (Helen) | Higher | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-232 |
---|
|
|
How / where to publish | Publish in RTD under "Use Cases" | Higher | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-233 |
---|
|
|
Migrate Seed Documentation from Wiki
Image Added
| Migration Process / Issues |
|
| Anuj Kapoor | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-179 |
---|
|
|
Setting Up ONAP |
| Higher | |
|
Integrating with ONAP |
| Higher | |
|
Using ONAP |
| Higher |
- Minor edits / table conversionMedium | Architecture / All Projects |
|
Documenting ONAP |
MediumDocumentationHighAPI's | Differentiate: - REST APIs - HealthCheck APIs - Components APIs (eg Java class API) | Medium | All Projects | Restructure existing content | Restructure / Remap existing content to Developer and SDK templates | Low | Glossary | Migrate Wiki content to RsT and expand content to include: - VNF Information Modeling terms - Indexing / tagging to enable Searching | Low | Modeling / Architecture | UTILITIES / TOOLS | External Installation Options | Installation / Lab options provided by: - Vendors (to be listed via request to mailing list) - Linux Foundation (if any available solution is ready) - ONAP Community (e.g. Orange OpenLab should be open soon, also Eric set up individual VM on Orange public cloud for APPC or SDNC to let people play with the DG, API… | Medium | ONAP.org | Lisa Caywood |
|
Glossary |
| Low | Modeling, Architecture |
|
ONAP Health & Maturity
Image Added
| Daily / Frequent Health Tests | - Daily health test results deployed by OOM and Heat
- Daily test results for vFW / vLB / vCPE
- 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 | |
|
Maturity | - Granularity
- E2E
- Project level
2. Maturity requirement: performance, resilience, etc. 3. Different tools: JProfile, Chaos Monkey, etc.
| Medium | |
|
URL | testresults.onap.org | Medium | LF |
|
|
|
|
|
|
|
---|
Doc Tool Chain / Utilities
Image Added
|
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 |
- Gerrit - Code Review/Verify Job |
- - Release Integration Test |
| Higher |
Medium /Documentation | RTD Lifecycle Feedback
| • | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-234 |
---|
|
|
RTD Feedback |
- JIRA project to report an error
|
• - Wiki or stack overflow Q&A
- Simple, more accessible link tool for editing RTD pages
|
| Medium | |
/Documentation
Rich Bennett ? | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-228 |
---|
|
|
Wiki Feedback
|
Establishing Establish new structure and process for: - Discussion forum
- Submitting suggestions / feedback with existing content
|
Low ()RTD Edit Tool | Simple, more accessible link tool for making changes on RTD pages | Low | Documentation | LF Tooling / Utilities | How to:
| Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-230 |
---|
|
|
LF Tool Chain Documentation - Gerrit guide
- Guidelines (Builds, etc.)
- Utilities: Jenkins, Conversion tools (e.g. LF Pandocs)
|
Low | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-229 |
---|
|
|
Rich Bennett ? |
|
|
|
|
|
|
---|
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
|
| | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-235 |
---|
|
|
VNF Certification | How and when to document: 1. Certified VNFs (when that happens) 2. Certified Platform elements |
|
| VVP | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-236 |
---|
|
|
Videos | Managing and tracking what and where videos are being posted |
|
| | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-237 |
---|
|
|
Wiki vs Readthedocs | How to best communicate guidelines on what content should be where | Image Added
|
| | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-238 |
---|
|
|