Transition the Qubes documentation to the Read the Docs (RTD) platform #8180
Labels
C: doc
C: website
community dev
This is being developed by a member of the community rather than a core Qubes developer.
P: default
Priority: default. Default priority for new issues, to be replaced given sufficient information.
S: in progress
Status: in progress. The assignee is currently working on this issue.
T: enhancement
Type: enhancement. A new feature that does not yet exist or improvement of existing functionality.
Community devs: @maiska, @tokideveloper
Checklist:
Original issue text
The problem you're addressing (if any)
There are new and increasing demands on the documentation, the main two being localization (i.e., translations) and release-specific docs (#5308). With these new demands, it has become increasingly difficult for the current system to meet our needs.
Back before we tried to address these kinds of needs, our documentation setup was simpler and served us well. The backend was smaller, easier to understand, and easier to maintain, since it didn't need to do much. There was only a single, canonical version of every documentation page.
However, times change. As our project has matured, we've decided it was time to acknowledge and take seriously the reality that not everyone reads English and not everyone uses the same version of Qubes OS at the same time. We have users and contributors from around the world, and we have multiple versions of Qubes.
There are times when an older Qubes release is supported concurrently with a newer release to give users time to upgrade. Even when there's only one currently-supported release, there's usually a new one in development and testing that folks want to start documenting. This means that we have to support a separate version of each appropriate documentation page for every translated language and for every supported and in-development Qubes version, not to mention historical documentation for EOL releases.
This is just a summary. In order to fully understand the context and background of this issue, please read the following mailing list threads:
The solution you'd like
Transition from the current system to the Read the Docs (RTD) platform (https://readthedocs.org, formerly https://readthedocs.io).
The value to a user, and who that user might be
These will benefit those who produce and consume Qubes documentation.
The text was updated successfully, but these errors were encountered: