| Table of Contents | ||
|---|---|---|
|
Introduction
Both the Specifications and the implementation sub-projects in Anuket have documentation produced in different style and different templates. The structure of the final documentation is not well designed and calls for rethink on how the documentation is organized. This requires a team which feels responsible for the different pieces of documentation and works for a consistent representation of them in the overall Anuket documentation.
Responsibilities
The documentation working group would responsible for:
...
- The technical content of the documentation except for the documentation guide. It is the sub-projects responsibility to provide the technical content of the documentation.
- Proofreading of the documents
- Making major edits to documentation workflows
...
- https://docs.anuket.io landing page of Anuket (docs folder in https://gerrit.opnfv.org/gerrit/opnfvdocs )
- https://cntt.readthedocs.io landing page of Anuket specifications (doc folder in https://github.com/cntt-n/CNTT)
- https://github.com/cntt-n/CNTT landing page of the Anuket specifications repo (root folder of https://github.com/cntt-n/CNTT)
- Documentation building framework for the Anuket specifications (tox,ini, conf.py _static, _templates files and folders in the folders of the documents in the Anuket specifications and in Anuket sub-projects) in a collaboration with the different sub-project contributors
- Documentation building framework and support of Anuket implementation projects in a collaboration with the different sub-project contributors
- https://docs.anuket.io/en/stable-kali/how-to-use-docs/ Documentation guide for Anuket
Committers
Meeting details
- Re-using the unused time slots of the Weekly Technical Meeting
Task management
- Use GitHub and a separate GitHub project under the CNTT repository
Action Items
- Take the proposal to the TSC to discuss.
- Update/refresh the existing CNTT guidelines
Comments about the proposal
Cédric Ollivier This presentation is fully unclear and looks like an overseed of activities done by other contributors.
...