/
Documentation improvements for end to end usage of ONAP

Documentation improvements for end to end usage of ONAP

Status and collaboration page for the "Documentation improvements for end to end usage of ONAP" project.

High Level MS Plan:

MS-1: Basic Operations and Administration Guides
          Basic SDC Design/Run time activities
MS-2: Advanced Operations and Administration Guides
          Advanced SDC Design/Run time activities
MS-3: CDS
MS-4: SO

Link for the MS plan in detail:

Documentation sections divided into multiple milestones accordingly based on Personas/Usage as described in the attached doc.

Doc_MS_Plan.pdf

Summary of the status:

Update on 

Documentation Section

Reported Jira/Gerrit tickets

Update on 

Documentation Section

Reported Jira/Gerrit tickets

Feb 1 - Feb 26

Updated all tutorial change requests after restructuring
the User Guide Section based on 117050



change request for vFW design tutorial: https://gerrit.onap.org/r/c/doc/+/117090
change request for vFW deployment tutorial: https://gerrit.onap.org/r/c/doc/+/11709
change request for vFWCL design tutorial: https://gerrit.onap.org/r/c/doc/+/117092

Jan 7 - Jan 25

Logging & Analytics

Tutorials:

vFW design tutorial

vFW deployment tutorial

vFWCL design tutorial

LOG-1239: Instructions on how to collect and provide standardized logs across all ONAP componentsOpen

https://gerrit.onap.org/r/c/logging-analytics/+/116685

https://gerrit.onap.org/r/c/doc/+/117090

https://gerrit.onap.org/r/c/doc/+/117091

https://gerrit.onap.org/r/c/doc/+/117092



Dec 11 - Jan 5

wiki links for tutorials

Resolved/Addressed merge conflicts

Tutorials : 

Instructions for K8S cluster setup on AWS

ONAP Service Design (vFW) Tutorial

ONAP Service Deployment (vFW) Tutorial

vFWCL Design Tutorial

Addressed merge conflicts:

https://gerrit.onap.org/r/c/oom/+/111360

https://gerrit.onap.org/r/c/doc/+/111971

https://gerrit.onap.org/r/c/oom/+/114380

merge requests are waiting for +2 :

SDC: 111971(9), VID: 113899(21), OOM: 111360(20), OOM: 114380(96), DOC: 116265(77)



Dec 2 - Dec 9

Control loop 

change request for DOC-681 : https://gerrit.onap.org/r/c/doc/+/116265

SDC-3403: Type field to select DCAE_INVERNTORY_BLUEPRINT has disappered in SDC Service Composition panel to create an ArtifactClosed

POLICY-2915: For control loop, the designed and submitted policies through CLAMP are not showing up in Policy GUIClosed

SO-3421: helm list is not showing DEV-SO release informationOpen

Nov 25 - Dec 1

DCAE MS deployment

DCAEGEN2-2534: [DOC] Few changes and uninstall steps to be added in DCAE MS VES-Mapper Installation documentation sectionOpen

change request: https://gerrit.onap.org/r/c/dcaegen2/+/115490

DCAEGEN2-2535: [DOC] DCAE tcagen2, ves-http and RestConf microservices installation documentation sections need to be updated with few notesClosed

change request: https://gerrit.onap.org/r/c/dcaegen2/+/115496

Nov 18 - Nov 24

DCAE health check

DCAE deployment validation

vFWCL design tutorial

DCAEGEN2-2530: [DOC] Few notes to be added under DCAE Deployment Validation and DCAE Health Check documentation Open

change request: https://gerrit.onap.org/r/c/dcaegen2/+/115283

CLSC-10: Control Loop design time tutorial (vFWCL)Closed

Nov 12- Nov 17

Backup and Restore

control loop

DOC-682: Backup and restore solution changes for ONAP component specific data bases Closed

change request: https://gerrit.onap.org/r/c/doc/+/114806

SDC-3383: Instructions on how to design a Control LoopClosed

Oct 29 - Nov 11

Robot Framework 

CLAMP

control loop design

INT-1776: robot framework documentation section need to be updated with few notes and sample outputsClosed

change request: https://gerrit.onap.org/r/c/integration/+/114782

CLAMP-962: CLAMPvideos-DesignpartinSDC reference media files are unable to openClosed

DOC-681: Instructions on how to design a Control Loop Closed



Oct 15 - Oct 28

oom-user-guide part of Platform Operations
Policy

sdc files path issue fixed

change request for POLICY-2867: https://gerrit.onap.org/r/c/policy/parent/+/114009

OOM-2602: Few changes need to added in oom-user-guide sectionsClosed

change request for OOM-2602: https://gerrit.onap.org/r/c/oom/+/114049

change request for SDC-3278: https://gerrit.onap.org/r/c/sdc/+/114264

change request for example-packages ref link issue: https://gerrit.onap.org/r/c/doc/+/114268

Oct 7 - Oct 14

Policy Installation

done with pending VID changes

POLICY-2866: Reference link for AAF automated configuration and Certificates is brokenClosed

change request: https://gerrit.onap.org/r/c/policy/parent/+/113904

https://lf-onap.atlassian.net/browse/POLICY-2868

change request: https://gerrit.onap.org/r/c/policy/parent/+/113915

https://lf-onap.atlassian.net/browse/POLICY-2867

Change request for VID-903: https://gerrit.onap.org/r/c/vid/+/113899

Sep 24 - Oct 5

Completed MS1

User Guides - SDC Design Time Tutorial

User Guides - SDC Run Time Tutorial



https://lf-onap.atlassian.net/browse/SDC-3304

https://lf-onap.atlassian.net/browse/SDC-3305

https://lf-onap.atlassian.net/browse/VID-903

https://lf-onap.atlassian.net/browse/SDC-3285

Sep 10 - Sep 23

User Guides - Run Time

https://lf-onap.atlassian.net/browse/SDC-3284

Change request : https://gerrit.onap.org/r/c/doc/+/112677

https://lf-onap.atlassian.net/browse/DOC-667

Change request : https://gerrit.onap.org/r/c/doc/+/112683

https://lf-onap.atlassian.net/browse/DOC-668

Change request : https://gerrit.onap.org/r/c/doc/+/112689

https://lf-onap.atlassian.net/browse/SDC-3285

https://lf-onap.atlassian.net/browse/SDC-3278

Aug 27 - Sep 9

User Guides

https://lf-onap.atlassian.net/browse/DOC-661

Change request: https://gerrit.onap.org/r/c/doc/+/111858

https://lf-onap.atlassian.net/browse/DOC-662

Change request: https://gerrit.onap.org/r/c/doc/+/111871

https://lf-onap.atlassian.net/browse/DOC-664

Change request: https://gerrit.onap.org/r/c/doc/+/111971

https://lf-onap.atlassian.net/browse/DOC-665

Change request: https://gerrit.onap.org/r/c/doc/+/111976

https://lf-onap.atlassian.net/browse/SDC-3266

https://lf-onap.atlassian.net/browse/SDC-3267

https://lf-onap.atlassian.net/browse/SDC-3268

https://lf-onap.atlassian.net/browse/SDC-3269

Aug 13 - Aug 26

Operations and Admin Guides

User Guides

https://lf-onap.atlassian.net/browse/OOM-2547 

https://lf-onap.atlassian.net/browse/OOM-2548 

Change request: https://gerrit.onap.org/r/c/oom/+/111699

https://lf-onap.atlassian.net/browse/OOM-2540

Change request: https://gerrit.onap.org/r/c/oom/+/111360

https://lf-onap.atlassian.net/browse/OOM-2541 

Change request: https://gerrit.onap.org/r/c/oom/+/111368

July 29 -Aug 12

Operations and Admin Guides

User Guides

https://lf-onap.atlassian.net/browse/DOC-650 

Change request: https://gerrit.onap.org/r/c/doc/+/110699

https://lf-onap.atlassian.net/browse/DOC-652 

https://lf-onap.atlassian.net/browse/OOM-2530 

Change request: https://gerrit.onap.org/r/c/oom/+/110873

https://lf-onap.atlassian.net/browse/DOC-655 

Change request: https://gerrit.onap.org/r/c/doc/+/111086

https://lf-onap.atlassian.net/browse/OOM-2536 

July 15 - July 28

Operations and Admin Guides

User Guides

https://lf-onap.atlassian.net/browse/DOC-634 

Change request: https://gerrit.onap.org/r/c/doc/+/109057

https://lf-onap.atlassian.net/browse/DOC-637 

Change request: https://gerrit.onap.org/r/c/doc/+/111093

https://lf-onap.atlassian.net/browse/DOC-648 





MS2 activities Plan:

Schedule

Documentation Section

Sub Tasks

Current 

Status

Schedule

Documentation Section

Sub Tasks

Current 

Status

Sep 29 - Oct 20

Platform Operations - Operations & Admin Guides

ONAP Operations

Oct 6 - Nov 30



Done





ONAP Testing &Monitoring with Robot Framework tool



Done





ONAP Testing & Monitoring with Consul tool



Done





ONAP Backup and Restore



Done





Logging & Analytics



Done

Sep 29 - Oct 28

User Guides - Design Time (Advanced)

Policy Design

Oct 6 - Nov 10



Done based on operators persona through CLAMP





Control Loop Design



Done





DCAE MOD User Guide



TBD





Tutorial - vFWCL Design



Done

Oct 29 - Nov 18

User Guides - Run Time (Advanced)

Control Loop Automation Management

Nov 11 - Mar 2021



Done 





DCAE MS Deployment



Done with VES-Mapper, RestConf, TCA-gen2 and ves-http DCAE microservices deployment sections





DCAE Deployment Validation



Done





DCAE Health Check



Done





Tutorial - vFWCL Deployment



In progress