Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move towards single-versioned documentation #718

Open
elstoc opened this issue Jan 5, 2025 · 1 comment
Open

Move towards single-versioned documentation #718

elstoc opened this issue Jan 5, 2025 · 1 comment

Comments

@elstoc
Copy link
Contributor

elstoc commented Jan 5, 2025

Given the problems we're having keeping the documentation up-to-date for each new version of the application, I propose that from here on we publish a single version of the documentation only, taken from the current master branch of this repository, and archive previous versions (so that they are still available but never rebuilt).

The documentation is generally published with a url schema like https://docs.darktable.org/usermanual/<version>/<language>/, where <version> is either a real version number (currently 3.6, 3.8, 4.0, 4.2, 4.4, 4.6 or 4.8) or the word "development" (for current master). There is also a "stable" version url that currently redirects to v4.8.

I propose that we keep the existing versions at their current path (as static files that are never auto-built again). In place of the "development" version, we publish "latest", which will still be a build from current master. In the future, any request with an unknown version number (i.e. any version except one of the "real version" list above) will redirect to "latest".

@elstoc
Copy link
Contributor Author

elstoc commented Jan 5, 2025

At some future point we will also need to re-enable a separate development build with a larger number of included languages than the "latest" build and find some way to automate this. For now, this change will allow help links to work from the current version without us having to build another unnecessary 5.0 branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant