Host documentation on our infra at docs.kiwix.org and docs.openzim.org
@rgaudin is already working on this.
Since Dec 13, 2024.
- Dominant language
- HTML
- Stars
- 9
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Currently, we build and publish documentation at readthedocs.io, benefiting from their free community tier.
In https://github.com/openzim/overview/issues/45, I've opened the topic of supporting them to remove adds, but unfortunately the price to pay is a bit too high from my PoV since it is 5$/month/project
Should we consider to build and host documentation on our own infra?
The difficult part would be to maintain doc for latest + all pinned versions, just like readthedocs does. readthedocs source code is open at https://github.com/readthedocs/readthedocs.org, but there is barely no documentation about self hosting, I doubt everything is in this repo, and it is probably not totally straightforward to deploy given the webhooks and build workers that are needed.
There is however also an opportunity:
- build a central homepage for all our documentation (currently it is barely possible to easily find all our documentation since they are different projects in readthedocs)
- build documentation even for older versions as a one-shot custom build done manually ; for instance for python-scraperlib, it is tough to rebuild documentation with readthedocs for previous version since readthedocs + mkdoc code/files are not present in the repo in every tagged version ; manually doing with a script backporting thing (without needed to commit them to the repo) is however mostly straightforward
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.