Skip to content

Security machine learning rule documentation improvements #2240

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 30 commits into from
Jul 25, 2025
Merged

Security machine learning rule documentation improvements #2240

merged 30 commits into from
Jul 25, 2025

Conversation

jmcarlock
Copy link
Contributor

@jmcarlock jmcarlock changed the title restructure ad page, add tips for linking between these pages Security machine learning rule documentation improvements Jul 23, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 23, 2025 •
edited
Loading

🔍 Preview links for changed docs

@jmcarlock jmcarlock marked this pull request as ready for review July 23, 2025 20:30
@jmcarlock jmcarlock requested a review from a team as a code owner July 23, 2025 20:30
sodhikirti07
sodhikirti07 approved these changes Jul 23, 2025
View reviewed changes
Copy link

@sodhikirti07 sodhikirti07 left a comment

Choose a reason for hiding this comment

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

Left one small suggestion, otherwise, everything lgtm!

susan-shu-c
susan-shu-c reviewed Jul 23, 2025
View reviewed changes
Copy link
Member

@susan-shu-c susan-shu-c left a comment

Choose a reason for hiding this comment

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

I'll do a more detailed review tomorrow, but I noticed that the previous is not rendering {ml-cap} properly: I do remember this being that variable that should render to Machine Learning so wonder why it's not rendering now in the preview build 🤔

Screenshot 2025-07-23 at 4 49 57 PM

@bmorelli25
Copy link
Member

bmorelli25 commented Jul 23, 2025 •
edited
Loading

Hi @susan-shu-c 👋. That variable is {{ml-app}} now.

docs-content/docset.yml

Line 100 in c7d2e6f

ml-app: "Machine Learning"

edit: hmm, we also have ml-cap

docs-content/docset.yml

Line 185 in c7d2e6f

ml-cap: "Machine learning"

edit edit: preview looks fine to me:
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2240/solutions/security/advanced-entity-analytics/anomaly-detection

Screenshot 2025-07-23 at 4 21 44 PM

bmorelli25
bmorelli25 reviewed Jul 23, 2025
View reviewed changes
bmorelli25
bmorelli25 reviewed Jul 23, 2025
View reviewed changes
solutions/security/advanced-entity-analytics/anomaly-detection.md
@@ -14,9 +14,16 @@ products:
# Anomaly detection
Copy link
Member

Choose a reason for hiding this comment

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

Whoever reviews this from my team: should we link to this page from:

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, it would make sense to link to it from the Data tables sections on those pages.

bmorelli25
bmorelli25 reviewed Jul 23, 2025
View reviewed changes
natasha-moore-elastic
natasha-moore-elastic reviewed Jul 24, 2025
View reviewed changes
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic 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 making these updates, @jmcarlock!

jmcarlock and others added 6 commits July 24, 2025 07:42
@jmcarlock @bmorelli25
Update solutions/security/advanced-entity-analytics/anomaly-detection.md
e204ae3 
Co-authored-by: Brandon Morelli <[email protected]>
@jmcarlock @natasha-moore-elastic
Update solutions/security/detect-and-alert/create-detection-rule.md
f97cff2 
Co-authored-by: natasha-moore-elastic <[email protected]>
@jmcarlock @natasha-moore-elastic
Update solutions/security/advanced-entity-analytics/anomaly-detection.md
bd150fd 
Co-authored-by: natasha-moore-elastic <[email protected]>
@jmcarlock @bmorelli25
Update solutions/security/advanced-entity-analytics/anomaly-detection.md
9e7c925 
Co-authored-by: Brandon Morelli <[email protected]>
@jmcarlock @natasha-moore-elastic
Update solutions/security/advanced-entity-analytics/anomaly-detection.md
9f716aa 
Co-authored-by: natasha-moore-elastic <[email protected]>
@jmcarlock @natasha-moore-elastic
Update solutions/security/detect-and-alert/create-detection-rule.md
6819c4f 
Co-authored-by: natasha-moore-elastic <[email protected]>
susan-shu-c
susan-shu-c approved these changes Jul 24, 2025
View reviewed changes
Copy link
Member

@susan-shu-c susan-shu-c left a comment

Choose a reason for hiding this comment

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

Looks good, ++ to Kirti's suggestion.

@jmcarlock jmcarlock requested a review from a team as a code owner July 24, 2025 14:05
@jmcarlock
Copy link
Contributor Author

Thanks @bmorelli25 @natasha-moore-elastic @susan-shu-c @sodhikirti07 for the review! I made additions/changes based on the feedback. @natasha-moore-elastic can you take one more look?

@natasha-moore-elastic
Copy link
Contributor

Thanks @bmorelli25 @natasha-moore-elastic @susan-shu-c @sodhikirti07 for the review! I made additions/changes based on the feedback. @natasha-moore-elastic can you take one more look?

@jmcarlock, I pushed some minor tweaks – should be good to merge now! 🚀

@jmcarlock jmcarlock enabled auto-merge (squash) July 25, 2025 13:22
@jmcarlock jmcarlock disabled auto-merge July 25, 2025 13:29
@jmcarlock jmcarlock enabled auto-merge (squash) July 25, 2025 13:45
@jmcarlock jmcarlock merged commit c966b11 into main Jul 25, 2025
8 of 9 checks passed
@jmcarlock jmcarlock deleted the security-ml-rules-improvements branch July 25, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorelli25 bmorelli25 bmorelli25 left review comments

@susan-shu-c susan-shu-c susan-shu-c approved these changes

@sodhikirti07 sodhikirti07 sodhikirti07 approved these changes

@natasha-moore-elastic natasha-moore-elastic natasha-moore-elastic approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jmcarlock @bmorelli25 @natasha-moore-elastic @susan-shu-c @sodhikirti07