Skip to content

[DOCS] Remove confusing topic about setting the monitoring user#14028

Merged
dedemorton merged 1 commit intoelastic:masterfrom
dedemorton:issue#8913
Oct 18, 2019
Merged

[DOCS] Remove confusing topic about setting the monitoring user#14028
dedemorton merged 1 commit intoelastic:masterfrom
dedemorton:issue#8913

Conversation

@dedemorton
Copy link
Copy Markdown
Contributor

Fixes #8913

Summary of changes:

  • Removed beats-system.asciidoc because it really doesn't add a lot of value and confuses users who are looking for content about setting up a monitoring user.
  • Fixed a mistake where we were using the wrong attribute to resolve the built-in user name.
  • Added a note for cloud users to let them know that the built-in users aren't defined there.
  • Changed hard-coded cloud product names to asciidoc references.
  • Fixed references to security docs that have moved recently (eliminates an unnecessary hop for users).

@dedemorton dedemorton added docs review needs_backport PR is waiting to be backported to other branches. labels Oct 11, 2019
@dedemorton dedemorton requested a review from a team as a code owner October 11, 2019 23:11
@dedemorton dedemorton requested a review from a team October 18, 2019 16:24
@dedemorton
Copy link
Copy Markdown
Contributor Author

@elasticmachine run elasticsearch-ci/docs

endif::[]

To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
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.

Did this need to change? Wouldn't it be better to go to the more general topic of monitoring the stack instead of monitoring an elasticsearch cluster?

Copy link
Copy Markdown
Contributor Author

@dedemorton dedemorton Oct 18, 2019

Choose a reason for hiding this comment

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

The general topic is light on actual useful content: https://www.elastic.co/guide/en/elastic-stack-overview/current/xpack-monitoring.html. It's really just a wrapper for links into the Elasticsearch (and other) monitoring docs. All the meaty overview content was moved to the Elasticsearch Reference. As a user, I would find it annoying to follow a link that promises to teach me more about monitoring, but instead tells me what I already know and sends me off to other stuff.

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.

Fair enough, thanks.

Copy link
Copy Markdown
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

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

LGTM.

@dedemorton dedemorton merged commit 363e349 into elastic:master Oct 18, 2019
@dedemorton dedemorton deleted the issue#8913 branch October 18, 2019 23:19
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Oct 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Securing Beats docs unclear for Elastic Cloud users

2 participants