Versions Compared

Old Version 6

changes.mady.by.user David McBride

Saved on

compared with

New Version Current

changes.mady.by.user Andreas Geissler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Topic Leader(s)

Topic Overview

Excerpt

ONAP documentation is based on RST files that are managed as code in Gerrit. A dedicated tool chain is then used (Sphinx) to publish the content as HTML files in ReadTheDocs. This session will detail the different tool used to genereta the doc and will present a local environment to help anyone to produce RST files and to validate them locally and to preview the content in the local environment (cf https://wiki.onap.org/display/DW/Local+environment+to+write+RST+files).

Slides & Recording

View file
nameONAP-Doc-Starter-Kit-v2.pdf
height250


View file
nameONAP - Documentation starter kit.mp4
height150

Minutes


Eric presented his slides:

Discussion and questions:

  • document verification has to be included in the Jenkins Verify Job and return -1 when detecting failures
    (https://jenkins.onap.org/view/rtdv3-global/)
  • → This is planned for Honolulu
  • doc_as_code toolset for VisualStudioCode looks very useful and will be tested ASAP (Andreas,Thomas)

Action Items

  •