2020-07-30 Doc project meeting

Attending

@Andreas Geißler @Thomas Kulik@Jakob Krieg@Ramakrishna GP

Topics, Notes, Status and Follow-Up Tasks



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

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 

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

@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)