DUNE-DAQ / daq-release

Scripts and configuration files for the DUNE DAQ release
https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/
2 stars 0 forks source link

Update the documentation #84

Closed jcfreeman2 closed 2 years ago

jcfreeman2 commented 3 years ago

Most of my comments here are based on my experience using the documentation to cut a new release (dunedaq-v2.7.0). However, some are a bit more general. Starting from the main page...

https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/:

https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/create_release/:

https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/make_ups_products/:

https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/add_modules_to_pypi_repo/:

https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/ci_github_action/:

https://dune-daq-sw.readthedocs.io/en/latest/packages/daq-release/publish_to_cvmfs/:

dingp commented 2 years ago

Many of the UPS-related pages should be removed since we moved to space-based release.

Release building and PyPI repo preparations have been automated by GitHub Actions, so those pages may be removed too, but information on how they are setup and run should be added to the GitHub Actions documentation.

dingp commented 2 years ago

Closing the issue after updating docs and removing(unlinking obsolete pages).