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 SectionReported 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 - Getting issue details... STATUS

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 9Control loop 

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

DCAEGEN2-2538 - Getting issue details... STATUS

POLICY-2915 - Getting issue details... STATUS

SO-3421 - Getting issue details... STATUS

Nov 25 - Dec 1DCAE MS deployment

DCAEGEN2-2534 - Getting issue details... STATUS

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

DCAEGEN2-2535 - Getting issue details... STATUS

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 - Getting issue details... STATUS

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

CLSC-10 - Getting issue details... STATUS

Nov 12- Nov 17

Backup and Restore

control loop

DOC-682 - Getting issue details... STATUS

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

SDC-3383 - Getting issue details... STATUS

Oct 29 - Nov 11

Robot Framework 

CLAMP

control loop design

INT-1776 - Getting issue details... STATUS

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

CLAMP-962 - Getting issue details... STATUS

DOC-681 - Getting issue details... STATUS


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 - Getting issue details... STATUS

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 - Getting issue details... STATUS

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

POLICY-2868 - Getting issue details... STATUS

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

POLICY-2867 - Getting issue details... STATUS

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


SDC-3304 - Getting issue details... STATUS

SDC-3305 - Getting issue details... STATUS

VID-903 - Getting issue details... STATUS

SDC-3285 - Getting issue details... STATUS

Sep 10 - Sep 23User Guides - Run Time

SDC-3284 - Getting issue details... STATUS

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

DOC-667 - Getting issue details... STATUS

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

DOC-668 - Getting issue details... STATUS

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

SDC-3285 - Getting issue details... STATUS

SDC-3278 - Getting issue details... STATUS

Aug 27 - Sep 9User Guides

DOC-661 - Getting issue details... STATUS

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

DOC-662 - Getting issue details... STATUS

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

DOC-664 - Getting issue details... STATUS

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

DOC-665 - Getting issue details... STATUS

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

SDC-3266 - Getting issue details... STATUS

SDC-3267 - Getting issue details... STATUS

SDC-3268 - Getting issue details... STATUS

SDC-3269 - Getting issue details... STATUS

Aug 13 - Aug 26

Operations and Admin Guides

User Guides

OOM-2547 - Getting issue details... STATUS  

OOM-2548 - Getting issue details... STATUS  

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

OOM-2540 - Getting issue details... STATUS

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

OOM-2541 - Getting issue details... STATUS  

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

July 29 -Aug 12

Operations and Admin Guides

User Guides

DOC-650 - Getting issue details... STATUS  

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

DOC-652 - Getting issue details... STATUS  

OOM-2530 - Getting issue details... STATUS  

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

DOC-655 - Getting issue details... STATUS  

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

OOM-2536 - Getting issue details... STATUS  

July 15 - July 28

Operations and Admin Guides

User Guides

DOC-634 - Getting issue details... STATUS  

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

DOC-637 - Getting issue details... STATUS  

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

DOC-648 - Getting issue details... STATUS  



MS2 activities Plan:

ScheduleDocumentation SectionSub TasksCurrent Status
Sep 29 - Oct 20Platform Operations - Operations & Admin GuidesONAP 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 28User 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 18User 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
  • No labels