Move to gitlab pages
@clemenci I have tested moving Gaussino docs to gitlab pages. Here are a few observations:
URL for the docs will have*.docs.cern.chsuffixA new project has to be added via webeos. The instructions are here:
https://how-to.docs.cern.ch/gitlabpagessite/create_site/create_webeos_project/https://how-to.docs.cern.ch/gitlabpagessite/create_site/set_up_pages/
Gitlab does not support versions, which is sth we would like to use for Gaussino & G-on-G. It looks like there's an open discussion here https://gitlab.com/gitlab-org/gitlab/-/issues/16208. I'm pretty sure there is some workaround for this, but I'm not sure that we actually want it.
I have tested this setup on a fork of Gaussino. The generated docs are accessible via https://mimazure-gaussino.docs.cern.ch/
Update 17/06/22
URL
The gilab pages for gaussino can be previewed via this link:
https://gaussino.docs.cern.ch/mimazure-gitlab-pages/index.html
Once merged to master, the master version will be available at:
https://gaussino.docs.cern.ch/
which will be redirected to https://gaussino.docs.cern.ch/master/index.html
Triggering the CI job
The deployment of the documentation will be handled in the following cases:
- protected branches
- commit tags that follow this pattern
vXXrXXpXX - by adding Python Documentation label to a MR
Handling versions on gitlab pages
As discussed during the core software meeting: accumulating versions of the gitlab pages will be handled via the use of an archive stored directly on the website. In a pipeline we download the content of the archive, add the new content and upload it again on the website. This is not ideal, as there might be problems when a few jobs are run simultaneously or if the archive is reachable, but this is to be tested.