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

Prebuilt detection rules: new UI for installing and upgrading #3552

Merged
merged 27 commits into from
Jul 25, 2023

Conversation

joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Jul 11, 2023

Features/issues covered:

Previews:

- "Installed Rules" tab
- "Add Elastic rules" button
@joepeeples joepeeples added Team: Detections/Response Detections and Response Feature: Rules Feature: Prebuilt rules v8.9.0 Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Large Issues that require significant planning, research, writing, and testing labels Jul 11, 2023
@joepeeples joepeeples self-assigned this Jul 11, 2023
@github-actions
Copy link

Documentation previews:

@joepeeples
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@joepeeples joepeeples requested review from banderror, approksiu and a team July 14, 2023 22:06
@joepeeples joepeeples marked this pull request as ready for review July 14, 2023 22:06
@nastasha-solomon nastasha-solomon self-requested a review July 17, 2023 19:25
Copy link
Contributor

@banderror banderror left a comment

Choose a reason for hiding this comment

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

Fantastic documentation update @joepeeples! 🎉

I did leave a few comments though, some of them are minor.

cc @xcrzx @jpdjere in case you'd like to take a look as well.

docs/cloud-native-security/d4c-get-started.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
@mergify

This comment was marked as resolved.

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Good idea breaking out the instructions for working with prebuilt rules. I left a handful of suggestions - hopefully they're helpful!

docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
docs/detections/rules-prebuilt.asciidoc Outdated Show resolved Hide resolved
Renamed file for good measure (though not necessary)
@approksiu
Copy link
Contributor

Thanks Joe! New docs look great!
https://security-docs_3552.docs-preview.app.elstc.co/guide/en/security/master/rules-ui-management.html#enable-detection-rules - I suggest removing this section with the video, it is outdated. cc @joepeeples

docs/whats-new.asciidoc Outdated Show resolved Hide resolved
@joepeeples joepeeples mentioned this pull request Jul 21, 2023
19 tasks
Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

I wasn't too nitpicky with comments in the interest of time, but this was a really great write-up, @joepeeples! I see Ksenia and Georgii left some feedback too. Once all that's incorporated, this will be good to go!

docs/detections/prebuilt-rules-management.asciidoc Outdated Show resolved Hide resolved
docs/detections/prebuilt-rules-management.asciidoc Outdated Show resolved Hide resolved
docs/detections/prebuilt-rules-management.asciidoc Outdated Show resolved Hide resolved
docs/detections/prebuilt-rules-management.asciidoc Outdated Show resolved Hide resolved
@mergify

This comment was marked as resolved.

Copy link
Contributor

@banderror banderror left a comment

Choose a reason for hiding this comment

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

Thank you @joepeeples for addressing all the comments! Looks great!

@joepeeples joepeeples merged commit 42a3e6c into main Jul 25, 2023
1 check passed
mergify bot pushed a commit that referenced this pull request Jul 25, 2023
* Rename tab, button

- "Installed Rules" tab
- "Add Elastic rules" button

* Fix docs bug: duplicating prebuilt rules

outdated instructions

* Add Asciidoc frontmatter

* Update "Install and enable" section

* Add "Update rules" section

* Break out prebuilt rules topic, add images

* Add frontmatter, li'l cleanup

* Fix x-docs link

* Add section on tag categories

Addresses #3525

* Revise description frontmatter

* Update image, add use case

* Update ref in Container Workload Protection

* Apply suggestions from reviews

1st round

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Georgii Gorbachev <[email protected]>

* Explain cost of duplicating rules

* Rename page

Renamed file for good measure (though not necessary)

* Tighten up images

* Apply feedback from Kseniia

* Remove outdated video

* Revise & move download section

* Apply suggestions from Janeen's review

Co-authored-by: Janeen Mikell Roberts <[email protected]>

* Remove download section, update xref

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Georgii Gorbachev <[email protected]>
Co-authored-by: Janeen Mikell Roberts <[email protected]>
(cherry picked from commit 42a3e6c)
@joepeeples joepeeples deleted the 3496-prebuilt-rules-UI branch July 25, 2023 14:41
joepeeples added a commit that referenced this pull request Jul 25, 2023
…#3621)

* Rename tab, button

- "Installed Rules" tab
- "Add Elastic rules" button

* Fix docs bug: duplicating prebuilt rules

outdated instructions

* Add Asciidoc frontmatter

* Update "Install and enable" section

* Add "Update rules" section

* Break out prebuilt rules topic, add images

* Add frontmatter, li'l cleanup

* Fix x-docs link

* Add section on tag categories

Addresses #3525

* Revise description frontmatter

* Update image, add use case

* Update ref in Container Workload Protection

* Apply suggestions from reviews

1st round

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Georgii Gorbachev <[email protected]>

* Explain cost of duplicating rules

* Rename page

Renamed file for good measure (though not necessary)

* Tighten up images

* Apply feedback from Kseniia

* Remove outdated video

* Revise & move download section

* Apply suggestions from Janeen's review

Co-authored-by: Janeen Mikell Roberts <[email protected]>

* Remove download section, update xref

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Georgii Gorbachev <[email protected]>
Co-authored-by: Janeen Mikell Roberts <[email protected]>
(cherry picked from commit 42a3e6c)

Co-authored-by: Joe Peeples <[email protected]>
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: Prebuilt rules Feature: Rules Priority: High Issues that are time-sensitive and/or are of high customer importance Team: Detections/Response Detections and Response v8.9.0
Projects
None yet
7 participants