search

FernLab / cookiecutter-py-package

Cookiecutter template for Python packages. Fork from https://github.com/audreyfeldroy/cookiecutter-pypackage.git
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Versionize gitlab pages documentation #2

Open romulogoncalves opened 1 month ago

romulogoncalves commented 1 month ago

All documentation available in gitlab pages should also be available and valid for different versions. The aim is not to have just the latest documentation available, but also preserve documentation versions of older tagged versions. It needs to be researched how this can be best integrated in the pipeline and how the documentation pages could be stored.

Related information: https://docs.gitlab.com/ee/user/project/pages/#create-multiple-deployments

danschef commented 1 month ago
  1. Why GitLab? We are on GitHub here.
  2. What is the plan about the documentation of the current repo? There is one coming from the fork at https://cookiecutter-pypackage.readthedocs.io/. Do we want to setup a GFZ/FERN.Lab-related documentation?
  3. Having a versionized documentation is a feature of ReadTheDocs. However, if we want to have the documentation in the same place as the repo code, we should keep in mind that the webspace for storing such files is limited and (depending on the complexity of the documentation) we could quickly fill it up. So probably it makes sense to store the last 3-5 version and delete older ones.
DaRa42 commented 1 month ago

For GitLab multiple deployments we would need a Premium or Ultra licence: https://about.gitlab.com/blog/2024/09/23/gitlab-pages-features-review-apps-and-multiple-website-deployment/

DaRa42 commented 1 month ago

we could use subfolders for tags, but could get large fast: `pages: script:

romulogoncalves commented 1 week ago

I do not think we should implement this in the cookiecutter. @danschef and @DaRa42 if you agree I would close this issue.