Refocus the System settings page as configuration methods#5569
Open
yetanothertw wants to merge 4 commits intomainfrom
Open
Refocus the System settings page as configuration methods#5569yetanothertw wants to merge 4 commits intomainfrom
yetanothertw wants to merge 4 commits intomainfrom
Conversation
Fixes #5341 * This page now explains where and how to apply OS limits and env vars (ulimit, limits.conf, sysconfig, systemd), using placeholders instead of baking in one concrete limits. * Also, removed some duplication with the file descriptior page. * Important system configuration list items now have short descriptions, for better orientation. * Realigned cross-links to the configuration methods page for how guidance on how to perfoem thse configuration changes on the host. * Clarified ulimit: listed common options (-n, -u, -l, -a) and pointed readers to `help ulimit` so the source of the options is explicit.
Contributor
Vale Linting ResultsSummary: 8 warnings, 7 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/self-managed/bootstrap-checks.md | 65 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
| deploy-manage/deploy/self-managed/bootstrap-checks.md | 65 | 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 | 65 | 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 | 65 | 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 | 74 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| deploy-manage/deploy/self-managed/executable-jna-tmpdir.md | 20 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| deploy-manage/deploy/self-managed/setting-system-settings.md | 92 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| deploy-manage/deploy/self-managed/setting-system-settings.md | 99 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
💡 Suggestions (7)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/self-managed/executable-jna-tmpdir.md | 20 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/deploy/self-managed/file-descriptors.md | 18 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
| deploy-manage/deploy/self-managed/file-descriptors.md | 22 | Elastic.Wordiness | Consider using 'use' instead of 'make use of'. |
| 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. |
| deploy-manage/deploy/self-managed/setting-system-settings.md | 38 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/deploy/self-managed/setting-system-settings.md | 43 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| deploy-manage/deploy/self-managed/setting-system-settings.md | 103 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', 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.
Contributor
eedugon
reviewed
Mar 20, 2026
eedugon
reviewed
Mar 20, 2026
Contributor
eedugon
left a comment
There was a problem hiding this comment.
I think it's looking very good!
I've added some suggestions to clarify better where the manual approach (ulimit command or limits.conf) is necessary in the intro of the doc.
deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/self-managed/setup-configuration-memory.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Contributor
Author
|
Thanks, Edu! I've implemented all your suggestions, so this is ready for your review again, please. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #5341
This page now explains where and how to apply OS limits and env vars (ulimit, limits.conf, sysconfig, systemd), using placeholders instead of baking in one concrete limits.
Also, removed some duplication with the file descriptior page.
Important system configuration list items now have short descriptions, for better orientation.
Realigned cross-links to the configuration methods page for how guidance on how to perfoem thse configuration changes on the host.
Clarified ulimit: listed common options (-n, -u, -l, -a) and pointed readers to
help ulimitso the source of the options is explicit.Summary
Generative AI disclosure
Used it to find other repetitions or topics that overlapped with these system settings configuration methods page.