2021-06-10 - Anuket: Working towards a consolidated documentation

Topic Leader(s)

• Gergely Csatari

Topic Overview

45 min | Gergely Csatari | EET

Documentation of Anuket is developed in different places and delivered to different places. I think we should keep the option to develop the documentation in different places, but we should deliver the documentation to a single place with similar look and feel. Let's discuss if this is an agreable target and what are the alternatives to achieve it.

Slides & Recording

Recording: Working towards a consolidated documentation.mp4

Agenda

No presentation

• Current OPNFV documentation: https://docs.opnfv.org/
  
  • Hosted in readthedocs
  • Compiled with sphinx
  • Uses the LFN theme
• Current CNTT documentation: https://cntt.readthedocs.io/en/latest/
  
  • Hosted in readthedocs
  • Compiled with Sphinx
  • Uses the default rtd theme
• Other current CNTT documentation: https://cntt-n.github.io/CNTT/
  • Hosted in GitHub
  • Compiled with the unknown GitHub compilation toolchain
  • Uses a GitHub Pages theme what I do not know
  • We will deprecate this
• Other current CNTT documentation: https://github.com/cntt-n/CNTT/tree/master/doc
  • Hosted on GitHub
  • Compiled with the unknown GitHub compilation toolchain
  • Uses the default GitHub theme

Minutes

Goal: Consistent documentation for Anuket = all Anuket project and spec docs available from same root access point and common look & feel

Theme Selections

OPNFV & CNTT Repos remain in GitHub and pointers will be setup in GitLab for archive and reference

Anuket will have a repo in GitLab when 

Suggestion: Rename the OPNFV Repo to Docs. 

ReadtheDocs is not dependent on repo location, We just need to identify the repos as the base material.

CNTT Finalized Readthedocs connected to Anuket Readthedocs 

Need an Anuket Theme - to replace OPNFV theme.

Action Items

• Trevor Bramwell , Scot Steele  and Gergely Csatari to meet and discuss how to create the Anuket rtd theme
• Trevor Bramwell to transfer the OPNFV docs project to GitLab
• Gergely Csatari to apply the Anuket theme to the OPNFV docs project
• Gergely Csatari disable the GitHub pages
• Gergely Csatari update the CNTT README.md anf remove the reference to the GitHub pages
• Trevor Bramwell Update the OPNFV rtd to refer to GitLab
• David McBride to provide a list of pages what we should keep from the former OPNFV documentation