Skip to content

Add ES Bootstrap Checks' errors#6535

Merged
stefnestor merged 7 commits into
elastic:mainfrom
stefnestor:stef_esBootstrapChecks
May 28, 2026
Merged

Add ES Bootstrap Checks' errors#6535
stefnestor merged 7 commits into
elastic:mainfrom
stefnestor:stef_esBootstrapChecks

Conversation

@stefnestor

Copy link
Copy Markdown
Member

Summary

We link the actual Elasticsearch bootstrap checks errors to the applicable docs already, but for google searchability, adding in the literal error strings.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@stefnestor stefnestor requested a review from a team as a code owner May 16, 2026 19:44
@github-actions

github-actions Bot commented May 16, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented May 16, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@github-actions

github-actions Bot commented May 16, 2026

Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 5 warnings, 5 suggestions found

⚠️ Warnings (5)
File Line Rule Message
deploy-manage/deploy/self-managed/bootstrap-checks.md 74 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
deploy-manage/deploy/self-managed/bootstrap-checks.md 74 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
deploy-manage/deploy/self-managed/bootstrap-checks.md 74 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
deploy-manage/deploy/self-managed/bootstrap-checks.md 74 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
deploy-manage/deploy/self-managed/bootstrap-checks.md 277 Elastic.Spelling 'http' is a possible misspelling.
💡 Suggestions (5)
File Line Rule Message
deploy-manage/deploy/self-managed/bootstrap-checks.md 58 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
deploy-manage/deploy/self-managed/bootstrap-checks.md 58 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
deploy-manage/deploy/self-managed/bootstrap-checks.md 63 Elastic.Semicolons Use semicolons judiciously.
deploy-manage/deploy/self-managed/bootstrap-checks.md 141 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
deploy-manage/deploy/self-managed/bootstrap-checks.md 332 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@stefnestor stefnestor enabled auto-merge (squash) May 16, 2026 22:43

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Docs review summary

Focus areas

  • Style and clarity: One non-standard word choice (inducecause) and a non-standard cross-reference pattern (Refer also toFor more information, see) in the new intro sentence. Vale found no violations.
  • Jargon: No unexplained jargon introduced.
  • Frontmatter and applies_to: Unchanged and valid.
  • Content type fit: Appropriate — error strings add useful search-discoverability context to each check section.
  • Parent issue satisfaction: Not applicable (no linked issue).

Key issue

The "Maximum size virtual memory check" section (line 138) has the same error message as the "Max file size check" section immediately above it (max file size [X] for user [Y] is too low). This is almost certainly a copy-paste error. The virtual memory check enforces unlimited address space (as), not file size — the error string should reflect that. Please verify against the Elasticsearch source.

Nits

  • Each "This can cause errors like" lead-in would read more naturally with a colon: "This can cause errors like:" (consistent throughout; fix all or none).
  • The serial collector error contains a raw %s placeholder rather than the [X]/[Y] format used in other sections. If that is the literal Elasticsearch error string, it's fine to keep as-is.

Generated by Docs review agent for issue #6535 · ● 346.5K

This can cause errors like

```text
max file size [X] for user [Y] is too low, increase to [unlimited]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Likely copy-paste error. This error message (max file size [X] for user [Y] is too low) is identical to the one in the "Max file size check" section above. The maximum size virtual memory check is about address space (as), not file size. The correct error message is likely something like:

max size virtual memory (of user [Y]) is too low, increase to [unlimited]

Please verify against the Elasticsearch source and replace with the actual address-space error string.

Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
stefnestor and others added 2 commits May 22, 2026 10:07
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
@stefnestor

Copy link
Copy Markdown
Member Author

Cheers, @yetanothertw! Ready again 🙏 .

FWIW for grammar-not-technical edits, you're welcome to directly edit not just suggest 🙂.

Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Comment thread deploy-manage/deploy/self-managed/bootstrap-checks.md Outdated
Linter suggestions

Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>

@yetanothertw yetanothertw left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

@stefnestor stefnestor merged commit 316e1f7 into elastic:main May 28, 2026
7 of 8 checks passed
@stefnestor

Copy link
Copy Markdown
Member Author

🙇‍♀️ cheers!

stefnestor added a commit that referenced this pull request Jun 6, 2026
## Summary

👋 Follow-up of #5848 to
create separate upgrade troubleshooting page.

This assumes but does not breaking rely on errors WIP documenting in
- #6534
- #6535
- #6536
- #6537
- elastic/elasticsearch#149765 
- elastic/elasticsearch#149768

It will hopefully be less necessary after
elastic/kibana#266733

There's various page cross-links/cross-reference between troubleshooting
"rolling upgrading Elasticsearch" and the "upgrade assistant" before it,
so starting together

<details><summary>Non-exhaustive related links</summary>

---

- https://support.elastic.co/knowledge/1bbb4cc9
-
https://discuss.elastic.co/t/issues-upgrading-elasticsearch-from-8-to-9-due-to-old-7-x-indices-and-restricted-kibana-indices/379133/11
- elastic/kibana#119652 (comment)
- https://support.elastic.co/knowledge/3e27188b
- https://support.elastic.co/knowledge/56149373
- https://support.elastic.co/knowledge/cb3db1e7
- https://support.elastic.co/knowledge/f3c6ea67
- elastic/elasticsearch#86801
- elastic/kibana#116209
- https://support.elastic.co/knowledge/295e812f
- https://support.elastic.co/knowledge/794038f9
- https://support.elastic.co/knowledge/dd79602f
- https://support.elastic.co/knowledge/e3d44d38

---

</details>

## Generative AI disclosure
1. Did you use a generative AI (GenAI) tool to assist in creating this
contribution?
- [ ] Yes  
- [X] No

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants