Anuket Project

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

 

Participants

Antitrust policies

Anuket Specifications in RTD and repo split

Anuket aims to produce GSMA documents per stream also rendered by Readthedocs (RTD).

  • all stream documentations should be standalone and published both in HTML to RTD and in DOCX/PDF for GSMA
  • ideally the main doc is just an umbrella listing the document per stream (note: it also contains specific documentation per stream) - only needed for RTD and has no meaning in GSMA
  • all RST could be on the same git tree as every RTD project settings redefined setup.py and conf.py which were in their specific dirs - but RTD dropped this capabilities
  • we now have to use the .readthedocs.yaml which must be unique and under root

Splitting the git tree is the only solution which doesn't diverge to our RTD+GSMA targets

  • only managing local builds via tox wouldn't help having the documentation on RTD
  • having a single documentation project would diverge from our GSMA target and would ask for many many manual editing of the GSMA documents. it would be such a regression compared for GSMA NG133

Pros/Cons splitting the git repo as it was discussed mostly from the beginning

  • Pros: it has been done in minutes by Cedric Ollivier  by keeping the full history of the projects
  • Pros: it fixes our current doc issues! and without any change in our documentation
  • Pros: it will help fine tuning the git rights according to the contributions per stream (and not falsy globally as today)
  • Cons: it will ask to publish the right change in the right repo and to create several PRs for overall changes (theme, tox version, etc.) - Nothing special here in LFN!

Here are some useful links which would have led the discussions:

AoB

  • None
  • No labels