-
-
Notifications
You must be signed in to change notification settings - Fork 393
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make documentation site work with multiple versions #9917
Conversation
Mind that for this to work on https://docs.decidim.org, we'll also need to change the Antora default branch. We can do that after these three PRs are merged (#9917, #9918 and #9919) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice improvement! Something that will be extremely useful for everyone.
Just one suggestion below as I think the more we can automate things, the less mistakes we will make along the line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more small cleanup.
* develop: (35 commits) Install turbo-rails (#9881) Fix conference invitations (#9664) Fix invalid rendering of meeting and proposal body texts (#9764) Make documentation site work with multiple versions (#9917) Bump versions on install docs (#9916) Standardize CSV import formats and fix private users CSV import with invalid file (#9627) Fix: The i18n locales selector is showing a dropdown with 3 languages (#9902) Make Scopes field in debates translatable (#9903) Make ToS agreement translatable (#9909) Fix issues with a11y specs (#9929) Remove invitations badge (#9906) Make initiatives order translatable (#9905) Add missing active actions on admin navigation menu (#9904) Fix user sign up with invalid name (#9896) Remove duplication of LastActivity queries (#9895) Rename IgnoredMethods to AllowedMethods in Rubocop configuration (#9893) Exclude malformed file from codeclimate configuration (#9910) Fix correct resource linking for amendments (#9887) Fix superposition in admin's error forms (#9871) Add missing i18n key in Initiatives (#9892) ...
* develop: (36 commits) Fix proposal etiquette and length validator with base64 images (#9639) Install turbo-rails (#9881) Fix conference invitations (#9664) Fix invalid rendering of meeting and proposal body texts (#9764) Make documentation site work with multiple versions (#9917) Bump versions on install docs (#9916) Standardize CSV import formats and fix private users CSV import with invalid file (#9627) Fix: The i18n locales selector is showing a dropdown with 3 languages (#9902) Make Scopes field in debates translatable (#9903) Make ToS agreement translatable (#9909) Fix issues with a11y specs (#9929) Remove invitations badge (#9906) Make initiatives order translatable (#9905) Add missing active actions on admin navigation menu (#9904) Fix user sign up with invalid name (#9896) Remove duplication of LastActivity queries (#9895) Rename IgnoredMethods to AllowedMethods in Rubocop configuration (#9893) Exclude malformed file from codeclimate configuration (#9910) Fix correct resource linking for amendments (#9887) Fix superposition in admin's error forms (#9871) ...
* Change version name in Antora configuration * Add docs for changing versions on documentation site * Automate changing versions with GemManager.replace_versions * Remove unnecessary assigment
馃帺 What? Why?
As I mentioned in #9916, we have a problem that currently instructions in https://docs.decidim.org are always on develop. This is problematic, some examples from http://chat.decidim.org from the last couple of months:
馃搶 Related Issues
Testing
As there are two repositories each with 3 branches it's tricky to try this out locally. What I've done is:
Mind that if you don't do all these steps, you'll have this error message:
This is because you don't have the correct version names or URLs configured in your repositories.
馃摲 Screenshots
(The idea is that after #9916 is merged, when you go to develop you'll have ruby 3.1.1, but on v0.27 you'll have 3.0.2)
doc-muilti-version-branches.mp4