2021-06-10 - Anuket: Working towards a consolidated documentation
- Gergely Csatari
- Trevor Bramwell
- Jim Baker
- Scot Steele
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
YouTube
Please indicate your session type in the blank space below and then remove this Info field.
Live Interactive Session
LFN Staff may elect to publish some videos to YouTube. Please indicate here if you do not want your session to be published to YouTube.
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.