Move the bootstrap checks from system config to settings config#6383
Conversation
Elastic Docs AI PR menuCheck 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. |
eedugon
left a comment
eedugon
left a comment
There was a problem hiding this comment.
Note that the preview is not working yet.
I'm totally ok with including bootstrap checks information in the important settings configuration doc, but I shared some comments about them.
| ::::{admonition} How these limits are enforced | ||
| This page lists operating system limits you must set before {{es}} serves production traffic. {{es}} verifies many of these expectations through [bootstrap checks](/deploy-manage/deploy/self-managed/bootstrap-checks.md) at node startup. In production mode, a failed check stops the node from starting rather than only logging a warning. | ||
|
|
||
| For what bootstrap checks are and how development mode differs from production mode, refer to [Important settings configuration](/deploy-manage/deploy/self-managed/important-settings-configuration.md#bootstrap-checks). | ||
| :::: | ||
|
|
There was a problem hiding this comment.
Having 2 links to undertand bootstrap checks doesn't feel natural.
LINK 1:
{{es}} verifies many of these expectations through bootstrap checks at node startup
LINK 2 in the next paragraph, to a different page but to the boostrap-checks section
For what bootstrap checks are and how development mode differs from production mode, refer to Important settings configuration.
IMO, the first link should also explain what bootstrap checks are and how development mode differs from production mode, so we wouldn't need a second link.
We need to review a bit the relation, scope and intention regarding bootstraps checks in the 3 docs:
- bootstrap checks doc
- important system config doc
- important settings config doc
There was a problem hiding this comment.
Okay, I've removed the second link and we now point only to the Bootstrap checks page.
My intention with this note was to conceptually link the system configuration limits that we set in the System config section/pages to how they're used in the bootstrap checks at node startup.
Is there anything else you think we need to add/mention here? @eedugon
There was a problem hiding this comment.
All good! I still see both links, but no worries.
It's just that needing two links to learn about bootstrap checks don't feel natural to me.
There was a problem hiding this comment.
That's odd, I think you may have gremlins in your system messing with your github today 😄
This is what the newly added admonition looks like (one link only):
There was a problem hiding this comment.
I was probably looking at a specific commit.... ( 🤦 )^2
:-D
Updating a link for elastic/docs-content#6383 I've moved the target content under a different file
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
Vale Linting ResultsSummary: 3 warnings, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/self-managed/important-settings-configuration.md | 34 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
| deploy-manage/deploy/self-managed/important-settings-configuration.md | 40 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
| deploy-manage/deploy/self-managed/important-settings-configuration.md | 40 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
💡 Suggestions (1)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/self-managed/important-system-configuration.md | 23 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', 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.
Now that elastic/docs-content#6383 has been merged, this little update ensures that we're pointing to the [Important settings configuration](https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration) page.
Updating a link for elastic/docs-content#6383 I've moved the target content under a different file
…8769) Now that elastic/docs-content#6383 has been merged, this little update ensures that we're pointing to the [Important settings configuration](https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration) page.
2 participants
Summary
Fixes #3140
Added a Bootstrap checks item at the top of the Important settings configuration page. I've included a short explanation that checks cover ES/JVM and OS limits, with links to Bootstrap checks and Important system configuration (host limits).
Updated the Important system configuration to remove the bootstraps section and replaced it with an admonition right after the checklist because I wanted to preserve some of the context that explains that OS limits can often fail checks in prod mode.
Note to the reviewer
The build is failing because of a link that needs to updated in elastic/elasticsearch#148641 which can only be merged once this PR has been merged and created that new link. It's kind of a chicken and egg situation, so you might need to build locally to review.
Generative AI disclosure
Yes, I used Claude in Auto mode to find relevant links that needed updating.