Skip to content

Conversation

kosabogi
Copy link
Contributor

@kosabogi kosabogi commented Apr 29, 2025

Context

As part of the rework of the ML anomaly detection book a new How-tos section was introduced. Some of the content currently listed there does not fully follow a how-to structure and needs to be updated to better align with the intended format.

About this PR

This is the first PR contributing to the https://github.com/elastic/search-docs-team/issues/27 issue for improving the How-to guides.

In this PR, I've restructured the Generating alerts for anomaly detection jobs guide to make it more task-focused and action-oriented. Updates include:

  • A clearer introduction
  • Simplified and structured text
  • Defined goals and prerequisites
  • Step-by-step instructions in an instructional style
  • Updated screenshots for 9.0 changes

As part of this effort, I'm also working on creating a shared How-to guide template to support consistency across all guides: https://docs.google.com/document/d/1dfbmAf4gZsNbY33gFKATRsIxJNJHqgN9C_BYZ2Jhff8/edit?usp=sharing

Preview

@kosabogi kosabogi changed the title WIP - Reworks 'Anomaly detection alert rules' part WIP - Reworks 'How to' guides in the Anomaly detection section Apr 29, 2025
@kosabogi kosabogi changed the title WIP - Reworks 'How to' guides in the Anomaly detection section WIP - Reworks 'How to' guides in the 'Anomaly detection' section Apr 29, 2025
@kosabogi kosabogi changed the title WIP - Reworks 'How to' guides in the 'Anomaly detection' section Reworks 'Generating alerts for anomaly detection job' guide' May 6, 2025
@kosabogi kosabogi requested a review from szabosteve May 6, 2025 10:55
@kosabogi kosabogi marked this pull request as ready for review May 6, 2025 10:55
@kosabogi kosabogi changed the title Reworks 'Generating alerts for anomaly detection job' guide' Reworks 'Generating alerts for anomaly detection jobs' guide' May 6, 2025
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!

@kosabogi kosabogi merged commit 3ed2c22 into main May 6, 2025
6 checks passed
@kosabogi kosabogi deleted the rework-how-to-guides branch May 6, 2025 12:31
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.

2 participants