Break upgrade guides into separate pages#20183
Open
mishop-15 wants to merge 1 commit intoapache:mainfrom
Open
Conversation
Fixes apache#20155 Split the single upgrading.md file into separate pages for each version to improve navigation and make ctrl-F search more useful. Previously all upgrade guides were on one page, making it difficult to determine which version was being viewed when searching for specific terms. Changes: - created docs/source/library-user-guide/upgrading/ directory - split upgrading.md into separate files (46.0.0.md through 53.0.0.md) - added index.rst to list all upgrade guide pages - updated main index.rst to reference upgrading/index - fixed internal links in api-health.md and 49.0.0.md
github-actions
bot
added
the
documentation
avantgardnerio
approved these changes
Feb 6, 2026
Contributor
avantgardnerio
left a comment
avantgardnerio
left a comment
There was a problem hiding this comment.
I don't know how to test this, but I see the separate files so LGTM
Contributor
|
Thank you @mishop-15 ! This will be very helpful since we're upgrading all the way from 42->52 :) |
Contributor
|
Looks like there are some CI faiures (we can test this by building the docs locally -- see instructions in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #20155
Which issue does this PR close?
Closes #20155
Rationale for this change
The upgrade guide was one giant page with all versions. When you search for something like "Aggregate", you get results from multiple versions and can't tell if you're looking at v46 or v44 changes.
What changes are included in this PR?
Split upgrading.md into separate files - one per version. Created an upgrading/ directory with an index similar to how user-guide/sql/ is organized.
Are these changes tested?
Built the docs locally with
make html. Each version now gets its own page and ctrl-F works within that version only.Are there any user-facing changes?
Yes - upgrade guides are now separate pages instead of one long page. Makes it easier to find version-specific info.