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

[DOCS] Updates anomaly detection alert docs with the new alerting terminology #70486

Merged
merged 5 commits into from
Mar 18, 2021

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Mar 17, 2021

Overview

This PR updates the anomaly detection alert docs to use the new alerting terminology. It also updates the screenshots to reflect the latest UI changes.

Main changes in terminology:

  • alerts --> rules
  • alert instance --> alert

Preview

Configuring anomaly detection alerts

@szabosteve szabosteve added :ml Machine learning >docs General docs changes v8.0.0 v7.13.0 labels Mar 17, 2021
@szabosteve szabosteve marked this pull request as ready for review March 17, 2021 13:30
@elasticmachine elasticmachine added Team:ML Meta label for the ML team Team:Docs Meta label for docs team labels Mar 17, 2021
@szabosteve szabosteve requested a review from lcawl March 17, 2021 13:30
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@szabosteve szabosteve requested a review from darnautov March 17, 2021 13:30
@szabosteve
Copy link
Contributor Author

@darnautov Thanks for the review. I addressed your suggestions via 7d3f21c

Copy link
Contributor

@darnautov darnautov left a comment

Choose a reason for hiding this comment

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

Latest edits LGTM

@lcawl
Copy link
Contributor

lcawl commented Mar 17, 2021

I can't submit it as a suggestion, but I think we should consider changing the title of this page too. For example, from:

Configuring {anomaly-detect} alerts

... to something like this (since I don't think you configure alerts anymore):

Generating alerts for {anomaly-jobs}

@szabosteve
Copy link
Contributor Author

Thanks @lcawl, I addressed your feedback via 419a6e8

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@szabosteve szabosteve merged commit 165c0dd into elastic:master Mar 18, 2021
@szabosteve szabosteve deleted the update.alerting.terms branch March 18, 2021 17:23
szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Mar 18, 2021
szabosteve added a commit that referenced this pull request Mar 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v7.13.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants