Skip to content

[DOCS] Refresh machine learning rule docs #92013

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Dec 5, 2022
Merged

[DOCS] Refresh machine learning rule docs #92013

merged 5 commits into from
Dec 5, 2022

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 30, 2022 •
edited
Loading

This PR updates https://www.elastic.co/guide/en/machine-learning/master/ml-configuring-alerts.html

In particular, it:

  • Fixes references to "Stack Management > Alerts and Actions", which should now be "Stack Management > Rules"
  • Clarifies that only one type of machine learning rule can be created in the ML app
  • Removes a screenshot which IMO is unnecessary and therefore doesn't need to be automated
  • Refreshes the remaining automated screenshots
  • Removes details that are covered in more detail in the Kibana alerting docs, adding links instead.

@github-actions
Copy link
Contributor

Documentation preview:

@lcawl lcawl added v8.6.1 v8.5.3 :ml Machine learning >docs General docs changes auto-backport Automatically create backport pull requests when merged labels Nov 30, 2022
@pxsalehi pxsalehi added v8.5.4 and removed v8.5.3 labels Dec 1, 2022
@lcawl lcawl marked this pull request as ready for review December 1, 2022 17:56
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:ML Meta label for the ML team labels Dec 1, 2022
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

@lcawl lcawl requested review from szabosteve and a team December 2, 2022 16:43
szabosteve
szabosteve approved these changes Dec 2, 2022
View reviewed changes
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

Thanks for tightening this up! LGTM.

@szabosteve
Copy link
Contributor

I'll remove the two screenshots that are removed here from the screenshot automation script in another PR.

@lcawl
Copy link
Contributor Author

lcawl commented Dec 2, 2022

I'll remove the two screenshots that are removed here from the screenshot automation script in another PR.

I re-added the one you'd automated (as well as refreshing the rest of the automated screenshots). Please take another look and see if you like where I've moved it.

lcawl
lcawl commented Dec 2, 2022
View reviewed changes
darnautov
darnautov approved these changes Dec 5, 2022
View reviewed changes
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.

LGTM

szabosteve
szabosteve approved these changes Dec 5, 2022
View reviewed changes
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl merged commit 3f2f9de into elastic:main Dec 5, 2022
@lcawl lcawl deleted the alerts-ui-fix branch December 5, 2022 15:48
@lcawl lcawl mentioned this pull request Dec 5, 2022
Merged
@lcawl lcawl mentioned this pull request Dec 5, 2022
Merged
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Dec 5, 2022
@lcawl
[DOCS] Refresh machine learning rule docs (elastic#92013)
a32c934
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.6
✅ 8.5

lcawl added a commit to lcawl/elasticsearch that referenced this pull request Dec 5, 2022
@lcawl
[DOCS] Refresh machine learning rule docs (elastic#92013)
8e6d06a
lcawl added a commit that referenced this pull request Dec 5, 2022
@lcawl
[DOCS] Refresh machine learning rule docs (#92013) (#92107)
7d92c3b
lcawl added a commit that referenced this pull request Dec 5, 2022
@lcawl
[DOCS] Refresh machine learning rule docs (#92013) (#92108)
4a9116a
@pxsalehi pxsalehi added v8.5.3 and removed v8.5.4 labels Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@darnautov darnautov darnautov approved these changes

@szabosteve szabosteve szabosteve approved these changes

Assignees
No one assigned
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :ml Machine learning Team:Docs Meta label for docs team Team:ML Meta label for the ML team v8.5.3 v8.6.1 v8.7.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lcawl @elasticsearchmachine @szabosteve @darnautov @pxsalehi