Participants

• @Cédric Ollivier

• @Karine Sevilla 

Antitrust policies

• Linux Foundation Anti-Trust Policy

• GSMA Anti-Trust Policy Notice

• Recorded Policies:

  • https://zoom.us/rec/play/uMAuIuyoqG43EtWS4QSDAf4oW9XsKP2s1CQW-fYNzxu3VSIGN1L3Z7YSNOX-H7MYUyogBuINABoVavXq?autoplay=true&startTime=1589371628000

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 non-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

• don't define link to png (rather leveral :numref:) 

• don't use doc role for internal link (rather consider a reference to the first title) 

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:

  • https://artifacts.opnfv.org/ra1/jenkins-cntt-tox-ra1-1414/anuketopenstackbasedreferencearchitecture.pdf (RA1)

  • https://artifacts.opnfv.org/rc2/jenkins-cntt-tox-rc2-1414/anuketreferenceconformanceforkubernetesrc2.pdf (RC2)

• RM uses special unicode checkmarks wich fails vs the default latex engine https://github.com/cntt-n/CNTT/issues/3004

• Several tables are too complex - under investigation

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

• tox now preprocesses :ref: to leverage internal links (see https://github.com/cntt-n/CNTT/pull/3013)

• a less destructive but partial solution would be to declare multiple readthedocs projects vs the same git repo

  • allows managing complex dependencies (RM n, RA1 n-1,  RC1 n-1)

  • remove any tox preprocessing (all intra links would be internal in tree)

  • avoid any false failure (if you create a ref to a new title in the same PR)

  • https://github.com/cntt-n/CNTT/commit/b2ddf3d333c35c9bcdca8b3f3352eaeff251cb98

  • main doc would only contain gov+common

AoB

• None