upgrade docs signifficant refinement #2296
Merged
Conversation
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
eedugon
commented
Jul 28, 2025
This was referenced Jul 28, 2025
kilfoyle
reviewed
Jul 29, 2025
kilfoyle
reviewed
Jul 29, 2025
kilfoyle
reviewed
Jul 29, 2025
kilfoyle
reviewed
Jul 29, 2025
kilfoyle
approved these changes
Jul 29, 2025
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
shainaraskas
approved these changes
Jul 29, 2025
There was a problem hiding this comment.
this update looks really nice and I think it is a big improvement. mostly commented style things but there are a couple of questions peppered in.
a couple of overall takeaways:
- do we think these docs all make sense for someone who has to upgrade from 8.18? just want to make sure the paths are solid.
- the procedures are quite dense and could possibly benefit from the stepper component, but that's not a problem for now
...oy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md
Show resolved
Hide resolved
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
eedugon
added a commit
that referenced
this pull request
Aug 8, 2025
Minor issues & leftovers after #2296
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
This PR include multiple changes and improvements in the upgrade docs:
Upgrade orchestrators moved downward in the TOC
Landing page (upgrade.md): Improved introduction, added an overview upgrade section as a map for the entire upgrade documentation, and upgrade-path to highlight that important information.
Plan upgrade: Scope clarified, the page is about general recommendations for the upgrade and compatibility verifications in order to create an upgrade plan. Added an
upgrade ordersection, and a finalexample.Prepare to upgade: We had lost part of the content (minor upgrades preparation steps) during the docs migration, and now that we have multiple 9.x versions that part feels needed. I've also re-worked that page and put all common steps (for major or minor upgrades) together, as the original asciidoc document (https://www.elastic.co/guide/en/elastic-stack/8.18/upgrading-elastic-stack.html) also felt repetitive and a bit duplicate.
Upgrade your deployment or cluster: changed a bit the intro and structure, plus added
out of orderreleases section, related and linked from the upgrade-paths of the landing page.Upgrade Elasticsearch self-managed (rolling upgrade instructions): Just minor changes adding some headings for better visibility.
I've tried to also position properly the documents in the flow, with "next steps" sections and proper introductions.
Closes: #1608
Part of the work of #1685