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 EPIC | Beijing Project-level Updates Image Modified
| 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 | |
All Liaisons | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-197 |
---|
|
|
|
|
|
|
|
|
---|
Interfaces Image Modified
| API - Structure & Tool Chain |
(required)- spec
Define best way to represent/visualize - RsT may not be best? - Containers
- Kubernetes
| | High |
All Projects with APIs | René Robert
Eric Debeau
Andy Mayer
| | 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 |
---|
|
|
user-f8be2 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 |
App Projects with APIs | | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-200 |
---|
|
|
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). |
Medium | On hold - Dave Neary moved to new role Multi-VIM owner going foward?
| Medium |
OpenStack (Dave Neary, Red Hat)Dave Neary
Lisa Caywood | 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 Modified | "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 | |
High | Project Leads
Lisa Caywood ?
Pawel Pawlak ? | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-224 |
---|
|
|
ONAP "Light" for |
novicesSEs, 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 Modified
| 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 |
to / 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 Modified
| 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 |
IntegrationOpenStack (, Red Hat)Documentation / SDC, Policy, CLAMP, VID Gregory Glover |
|
Architecture |
| Higher | Architecture / All Projects |
|
Documenting ONAP |
| Higher |
Documentation | |
|
Developing ONAP |
| Higher | All Projects |
|
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 Modified
| 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 | |
| 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 | |
?Lisa Caywood ?
Rich Bennett | Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-228 |
---|
|
|
Wiki Feedback Establish new structure and process for: - Discussion forum
- Submitting suggestions / feedback with existing content
|
| Medium | |
?Rich Bennett | 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)
|
| Lower | |
| Jira |
---|
server | ONAP JIRA |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
key | DOC-229 |
---|
|
|
|
|
|
|
|
|
---|
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 |
---|
|
|