Skip to content

Refocus the System settings page as configuration methods#5569

Open
yetanothertw wants to merge 4 commits intomainfrom
5341-system-config
Open

Refocus the System settings page as configuration methods#5569
yetanothertw wants to merge 4 commits intomainfrom
5341-system-config

Conversation

@yetanothertw
Copy link
Contributor

@yetanothertw yetanothertw commented Mar 19, 2026

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.

Summary

Generative AI disclosure

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

Used it to find other repetitions or topics that overlapped with these system settings configuration methods page.

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.
@github-actions
Copy link
Contributor

github-actions bot commented Mar 19, 2026

Vale Linting Results

Summary: 8 warnings, 7 suggestions found

⚠️ Warnings (8)
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.

@yetanothertw yetanothertw marked this pull request as ready for review March 20, 2026 11:14
@yetanothertw yetanothertw requested a review from a team as a code owner March 20, 2026 11:14
Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

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.

Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
@yetanothertw
Copy link
Contributor Author

Thanks, Edu! I've implemented all your suggestions, so this is ready for your review again, please.

@yetanothertw yetanothertw requested a review from eedugon March 20, 2026 15:16
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.

Important system configuration - child docs content overlaps

2 participants