Break upgrade guides into separate pages#20183
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
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
|
Thank you @mishop-15 ! This will be very helpful since we're upgrading all the way from 42->52 :) |
|
Looks like there are some CI faiures (we can test this by building the docs locally -- see instructions in |
@alamb fixed the CI failures, prettier formatting is now correct and docs build successfully locally. |
@avantgardnerio You can test it by building the docs locally (cd into docs/ and run |
|
CI still seems to fail |
@alamb The issue was the header structure when I split the file, I used |
|
Definitely an improvement, thank you! I can click into each guide and do Unfortunately when I click on "Upgrade Guides", I see this: 
It would be good to have them numbered so users don't have to click on each one. |
@avantgardnerio added the version numbers. 
|
Fantastic, thank you @mishop-15 ! I really appreciate your help! I've clicked "merge when ready" so I think it should be part of |
File was renamed and split into smaller files as part of apache#20183.
File was renamed and split into smaller files as part of #20183. ## Rationale for this change CI is failing with: ``` Doc-tests datafusion error: couldn't read `datafusion/core/src/../../../docs/source/library-user-guide/upgrading.md`: No such file or directory (os error 2) --> datafusion/core/src/lib.rs:1182:1 | 1182 | / doc_comment::doctest!( 1183 | | "../../../docs/source/library-user-guide/upgrading.md", 1184 | | library_user_guide_upgrading 1185 | | ); | |_^ | = note: this error originates in the macro `include_str` which comes from the expansion of the macro `doc_comment::doctest` (in Nightly builds, run with -Z macro-backtrace for more info) ``` <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. -->
|
FWIW this caused a build issue in #20218 Kudos to @neilconway and @Jefffrey for fixing |
3 participants
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.