Anuket Project
Anuket Weekly Technical Discussions - 2022.06.01
Participants
Antitrust policies
- Linux Foundation Anti-Trust Policy
- GSMA Anti-Trust Policy Notice
- Recorded Policies:
Computing Force Network jie niu
- jie niu was invited to compare the requirements defined in RM to the infra requirements of CFN,
Doc conversion Cédric Ollivier
Our golden rules:
- no manual numbering (sphinx manages this part when rendering)
- leverage :numref: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-numref for figure refs
- no unicode character (it would break PDF rendering)
- use " and '
- double check blank chars if you leverage Github editor (I would rather recommend any IDE)
- check the gate before merging https://build.opnfv.org/ci/view/cntt/
- enable doc8 without any exception and linkcheck
PDF rendering is ongoing
- wrapping to 120 could easily break the PDF rendering (80 could too in specific cases)
- please leverage table and list-table directives which automatically adds the captions https://docutils.sourceforge.io/docs/ref/rst/directives.html
- to tune the LaTeX theme and to make the PDF closer to the GSMA one
- WIP:
Please check any inconsistency between PDF/HTML and GSMA
- to include abbrevations, etc. instead of refering to a common rst
- to add the missing GSMA sections in our source code
One tag for the whole CNTT project ? Do we split the git repository?
- intersphinx defacto fails if RM and RA1 are not aligned
- ideally we should add one tag per stream published in GSMA
AoB
- None