2020-08-20 Doc project meeting II

Upcoming milestones and release planning for docs

We walked through all Jira tickets for Guilin release. Please keep adding tasks as they occur. 

@Sofia Wallin to invite @Andy Mayer to next weeks meeting to get an status update on the work with API documentation. 

Thanks to Andreas who managed the maintenance releases for ElAlto and Frankfurt. 

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

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 

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

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

@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

New RST Sphinx extention for CDS Guide 

@Jakob Krieg

CDS Guide in Confluence uses "Tabs" (see Modeling Concepts)

Jakob helps the CDS project to migrate the documentation to RTD and found a Sphinx extention to support tabs (extensions = ['sphinx_tabs.tabs']).
He adds it to the conf.py in the CDS repo.

When we successfully use this plugin, a suggestion would be to create a presentation for the TSC/PTL call to promote all tools and extentions in RTD to gain more acceptance to write RTD documents.

Possible content:

• Swagger API documentation

• Sphinx_tabs

• Clickable Pictures (Eric)

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