2020-08-27 Doc project meeting

Upcoming milestones and release planning for docs

To be finalized Guilin Release Planning for docs

Sofia to add the basics of the documentation project as well as specific. The team will elaborate on their specific areas/content for more details. 

Encouraging everyone to add planned documentation updates to the documentation tracking page https://lf-onap.atlassian.net/wiki/x/ubT6 

API documentation @Andy Mayer

Update regarding API documentation handling.

REQ-386 REQ-386: Apply common Swagger style and documentation generation tools to create robust ONAP API documentationDone

wiki link for instruction Developing ONAP API Documentation

Andy to check with Eric and Adrian if they have a template in place? 

Moving forward we would move the instruction and template to the official documentation guide on RTD. 

Notes from earlier meeting,

@Andy Mayer to capture non-functional requirements for Guilin in Jira, create an Epic in the doc project with associated task for each component. 

He will also support with updating the documentation guide with a swagger instruction. 

Documentation guide 

@Thomas Kulik @Jakob Krieg

@Thomas Kulik : Documentation Developer Guide (https://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/index.html) extention planned for Beginners and restructure extisting Guide (DOC-602: Documentation guide refinementClosed)

@Jakob Krieg : Created ticked about Testing instructions DOC-651: Update Guide for Testing One ProjectClosed

Update "Documentation improvements for end to end usage of ONAP"

@Aarna Networks

Suggested to create a wiki page to visualise the progress of the project. Also to add other relevant information such as milestone plan and the finial SOW.

@Sofia Wallin to create a wiki

DONE Documentation improvements for end to end usage of ONAP

******************************************************************

@Ramakrishna GP Users guide, Operations Guide analysed.

Tickets raised and changeset created 
Tickets: 

DOC-650: [Doc]VNF Validation Documentation link is broken in pre-onboarding sectionClosed https://gerrit.onap.org/r/c/doc/+/110699

OOM-2669: Extra commands needed under "ONAP on HA Kubernetes Cluster" doccumentation sectionClosed, should be raised on OOM project

Local environment to write RST files @Eric Debeau

@Eric Debeau presented local documentation testing. We will document a basic for version for local RST rendering. Further extensions will be available if needed/wanted (such as spell checker + Linter) but this requires a more extensive set of tools. To be presented in the PTL call for feedback.

 ************************************************************************************

Local environment to write RST files and detect

Visual Studio Code IDE + Extensions (Spell Checker + Linter)

Automatic preview aligned with ONAP documentation schemes