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

Revises 8.x-8.x upgrade guide #5830

Merged
merged 5 commits into from
Oct 24, 2024
Merged

Revises 8.x-8.x upgrade guide #5830

merged 5 commits into from
Oct 24, 2024

Conversation

natasha-moore-elastic
Copy link
Contributor

Contributes to #5302.

Revises the instructions for upgrading from an 8.x to an 8.x version. Mostly reuses the content from the 7.17 to 8.x upgrade guide, but without the 7.17-specific information.

@natasha-moore-elastic natasha-moore-elastic added Feature: Upgrading Priority: Medium Issues that have relevance, but aren't urgent v8.10.0 Effort: Small Issues that can be resolved quickly v8.11.0 Docset: ESS Issues that apply to docs in the Stack release v8.12.0 v8.13.0 v8.14.0 v8.15.0 v8.16.0 labels Sep 13, 2024
@natasha-moore-elastic natasha-moore-elastic self-assigned this Sep 13, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

joepeeples
joepeeples previously approved these changes Sep 16, 2024
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few optional suggestions, so went ahead and approved in case you want to merge now. Ping again if you need re-approval!

docs/upgrade/upgrade-security.asciidoc Outdated Show resolved Hide resolved
docs/upgrade/upgrade-security.asciidoc Outdated Show resolved Hide resolved
docs/upgrade/upgrade-security.asciidoc Outdated Show resolved Hide resolved
docs/upgrade/upgrade-security.asciidoc Outdated Show resolved Hide resolved
joepeeples
joepeeples previously approved these changes Sep 20, 2024
joepeeples
joepeeples previously approved these changes Sep 20, 2024
@111andre111
Copy link

111andre111 commented Sep 25, 2024

Looking to the rendered docs page https://security-docs_bk_5830.docs-preview.app.elstc.co/guide/en/security/master/upgrade-intro.html
I have a little general observations question.
We have these headers for upgrades of pre-8.x upgrades:
Screenshot 2024-09-25 at 09 52 03
Screenshot 2024-09-25 at 09 51 47
In comparison to that the 8.x to 8.x Upgrade has a completely other header size level. For me at least from a readability perspective that doesn't sound about right.
Screenshot 2024-09-25 at 09 52 17
In my opinion, there there should be the same separate header level for that section and if there are overlapping sections, these could be linked together, like third step that needs to be done is x, see section <link to y>.

Please correct me if I am wrong.

@natasha-moore-elastic
Copy link
Contributor Author

Looking to the rendered docs page https://security-docs_bk_5830.docs-preview.app.elstc.co/guide/en/security/master/upgrade-intro.html I have a little general observations question. We have these headers for upgrades of pre-8.x upgrades: Screenshot 2024-09-25 at 09 52 03 Screenshot 2024-09-25 at 09 51 47 In comparison to that the 8.x to 8.x Upgrade has a completely other header size level. For me at least from a readability perspective that doesn't sound about right. Screenshot 2024-09-25 at 09 52 17 In my opinion, there there should be the same separate header level for that section and if there are overlapping sections, these could be linked together, like third step that needs to be done is x, see section <link to y>.

Please correct me if I am wrong.

Hi @111andre111, thanks for having a look. Perform an 8.x to 8.x upgrade on a deployment is a subsection within the Upgrade from an earlier 8.x version section, which is why the heading sizes are different. Both sections talk about the same kind of upgrade (8.x to 8.x)

Essentially, Upgrade from an earlier 8.x version consists of the following steps:

  1. Plan for your upgrade
  2. Pre-upgrade steps
  3. Perform the upgrade

Maybe this would be clearer if we renamed Upgrade from an earlier 8.x version to Upgrade from an 8.x to an 8.x version. This would also be consistent with the other main section titles (Upgrade from 7.17 to an 8.x version and Upgrade from 7.16 or earlier to an 8.x version).

@natasha-moore-elastic natasha-moore-elastic merged commit 1c62f2d into main Oct 24, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Oct 24, 2024
* Revises 8.x-8.x upgrade guide

* Address editorial feedback

* Applies feedback to 7.17 guide

* Updates section name

(cherry picked from commit 1c62f2d)

Co-authored-by: natasha-moore-elastic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docset: ESS Issues that apply to docs in the Stack release Effort: Small Issues that can be resolved quickly Feature: Upgrading Priority: Medium Issues that have relevance, but aren't urgent v8.10.0 v8.11.0 v8.12.0 v8.13.0 v8.14.0 v8.15.0 v8.16.0 v8.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants