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

Update heap setting documentation in light of machine dependent heap #66567

Merged
merged 13 commits into from
Dec 18, 2020

Conversation

mark-vieira
Copy link
Contributor

@mark-vieira mark-vieira commented Dec 17, 2020

Documentation updates to our heap size recommendations as a follow up to #65905.

@mark-vieira mark-vieira added >docs General docs changes v8.0.0 labels Dec 17, 2020
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Dec 17, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

This looks good to me overall. I left a few comments and suggestions but nothing blocking.

I think creating the Advanced configuration settings page is a good move. However, we probably want to tell users that they shouldn't mess with these unless they know what they're doing. We get a lot of search traffic, and I could see someone landing here without other context.

It may also be worth auditing some of our xrefs to the current heap size settings. I found one during the review, but there may be others. I can do that as a separate effort if wanted though.

Thanks @mark-vieira!

docs/reference/setup/important-settings/heap-size.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/important-settings/heap-size.asciidoc Outdated Show resolved Hide resolved
@@ -0,0 +1,89 @@
[[advanced-configuration]]
=== Advanced configuration settings

Copy link
Contributor

Choose a reason for hiding this comment

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

You may want to add a couple brief sentences before the heap size heading. I'd just note:

  • We recommend using default settings in most production use cases
  • These settings are for experts only.

If someone lands on this page from Google, they should see "There be dragons here."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added some language here.

Copy link
Contributor

Choose a reason for hiding this comment

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

New copy looks great to me! Thanks!

docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/advanced-configuration.asciidoc Outdated Show resolved Hide resolved
mark-vieira and others added 10 commits December 18, 2020 10:53
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
@mark-vieira
Copy link
Contributor Author

Thanks for the review @jrodewig! I've applied your suggested and made a couple other minor tweaks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v7.11.1 v7.12.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants