Open MyPyDavid opened 1 year ago
we can use https://github.com/rdmorganiser/rdmo/blob/master/.github/workflows/ci.yml as inspiration
We could also drop readthedocs (because of the advertisement) and deploy it to rdmorganiser.github.io/docs/
or even move everything to rdmo.org, which I accidentally own :grin: .
What do you prefer?
I would stick with GitHub pages or readthedocs.
Did you decide on having "only" the latest docs online?
I am confused about the usage of RDMO_VERSION in the docs, which is only rendered locally but shown as latest on rtd.
If there should be no deploy pipeline for the docs, I would still propose adding a CI job to lint, build and linkcheck. What do you think?
e.g. ruff (only conf.py, maybe overkill), markdownlint (for the md files), and pre-commit hooks for trailing whitespace etc.
I like rdmorganiser.github.io/docs
but then we need some kind of dummy repo to guide users from rdmo.readthedocs.io to that page. (or a redirect). We would get rid of the ads.
I think the last merged PR is not yet deployed to https://rdmo.readthedocs.io/, there is no mention of "Keycloak" yet https://rdmo.readthedocs.io/en/latest/search.html?q=keycloak&check_keywords=yes&area=default.
Suggestion: It would be easier to have here a pipeline installed via the Github Actions or via a webhook integration: