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

Add ML jobs installed via Elastic integrations to docs #3647

Closed
susan-shu-c opened this issue Jul 27, 2023 · 5 comments
Closed

Add ML jobs installed via Elastic integrations to docs #3647

susan-shu-c opened this issue Jul 27, 2023 · 5 comments
Assignees
Labels
Effort: Large Issues that require significant planning, research, writing, and testing Feature: Machine Learning Feature: Prebuilt rules Priority: High Issues that are time-sensitive and/or are of high customer importance v8.9.0 v8.10.0

Comments

@susan-shu-c
Copy link
Member

susan-shu-c commented Jul 27, 2023

Description

Currently, the prebuilt jobs reference page under Anomaly detection with machine learning only covers standalone jobs.

However, anomaly detection jobs can also be installed via Elastic integrations.

To make it easier for users to view these jobs all in one place, we'd like to add the jobs from integrations to one place.

Primarily, the change will be to these pages.

Changes (proposed)

Anomaly Detection with ML

  • Add sentence at beginning,
  • Add section below “pre-built rules” to explain what advanced analytics use case packs are, introducing integration packages that install jobs – similar to Apoorva/Kseniia/Steve said

Prebuilt job reference → rename

Update, seems that part of the code edits are here:

Acceptance Test Criteria

List all the ATC of each action and its intended result.
For example: As a user, when [action (e.g., viewing, clicking, selecting, etc.)] I should [insert the expected result].

Notes

  • Add all appropriate labels to the issue, especially the version number label.
  • Be sure to add any necessary screenshots, code text or console commands for clarity.
  • Include any conditions or caveats that may affect customers.

Related ticket

@susan-shu-c
Copy link
Member Author

susan-shu-c commented Jul 27, 2023

@terrancedejesus, I saw that you made the most recent changes to the prebuilt jobs reference pages, and that the rules are automated off jobs' info via these scripts: https://github.com/elastic/security-docs/tree/main/prebuilt-rules-scripts

I've tried installing the required packages, but wanted to check in to see how we can introduce adding the jobs from Elastic integrations into this doc page without breaking the scripts?

Since the scripts read from very specific locations, I want to see if we can add to them, or perhaps just add this manually (hopefully not though!)

The idea is to add more sections like this: (from https://docs.elastic.co/integrations/problemchild#anomaly-detection-jobs)

Screenshot 2023-07-25 at 12 29 20 PM

@susan-shu-c
Copy link
Member Author

susan-shu-c commented Aug 1, 2023

Quick update:

I've made PRs but still need to confirm if there is more information to add, will follow up this week.

@jmikell821 jmikell821 added Feature: Prebuilt rules Feature: Machine Learning v8.9.0 Priority: High Issues that are time-sensitive and/or are of high customer importance v8.10.0 Effort: Large Issues that require significant planning, research, writing, and testing labels Aug 2, 2023
@susan-shu-c
Copy link
Member Author

Update

Edit docs in security-docs and stack-docs and gotten reviews
Discussing with documentation/tech writer team for final approval

@susan-shu-c
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: Large Issues that require significant planning, research, writing, and testing Feature: Machine Learning Feature: Prebuilt rules Priority: High Issues that are time-sensitive and/or are of high customer importance v8.9.0 v8.10.0
Projects
None yet
Development

No branches or pull requests

2 participants