[DOCS] New rule fields for prerequisites: Related Integrations, Required Fields, and Setup #2069

joepeeples · 2022-06-13T18:14:49Z

Addresses #2015.

Previews:

Manage detection rules | View related integrations and required fields — new section
Advanced Settings — new section
Detection rule APIs — added fields to response samples:
- Create rule (5 response examples)
- Get rule
- Find rules
- Update rule
- Bulk rule action (Example 1 and Example 2)
Release notes 8.3.0 — Added under "Features"

Joe's Li'l Checklist

Update 8.4 Release Notes and What's New once we confirm new fields & content are going into 8.4 (Separate PR because 8.4 RNs and What's New have already been merged for the release): [DOCS] Prebuilt rules prerequisites: Update Release Notes and What's New in 8.4 #2384
⚠️ NOTE: We also need to update What's New in 8.3, but we can't do that with this PR because it's merging to main, where What's New is being worked on for 8.4. I created PR [DOCS] Prebuilt rules prerequisites: Add new section to What's New in 8.3 #2327 to update 8.3 directly.

joepeeples · 2022-06-28T20:28:30Z

This feature has been held back from the 8.3.0 release, but keeping the v8.3.0 label for now in case the feature becomes available soon after the release.

Includes placeholder image syntax, commented out

docs/detections/rules-ui-manage.asciidoc

banderror · 2022-08-23T19:38:32Z

docs/release-notes/8.3.asciidoc

+* Adds new fields to prebuilt detection rules' schemas: `related_integrations`, `required_fields`, and `setup` ({pull}132409[#132409]).
+* Adds *Related integrations*, *Required fields*, and *Setup guide* sections to the rule details page, to help users identify, install, and configure a rule's prerequisites. Also adds related integrations badge to the rules table ({pull}131475[#131475]). Content for these new sections is delivered in a prebuilt rules update, independent of {stack} release versioning.


Are we going to update the 8.3 release notes? Am I understanding correctly that we'll do it only if rules with those fields will be released in one of the 8.3.x Out-Of-Band updates for the Prebuilt Detection Rules package?

@banderror Yes, this section will update the 8.3 release notes (the file name is version-specific).

For 8.4 release notes, we have a separate PR that's currently in progress, though it doesn't yet mention the new fields because they're not yet available in the UI. Once I can confirm that, I'll add the same wording from above to those 8.4 notes.

Basically before we merge anything related to the new fields, I'm waiting to confirm that the latest prebuilt rules package has been published and the new fields are available in both 8.3.x and 8.4.0.

nastasha-solomon

Just a couple minor edits. LGTM otherwise!

docs/detections/rules-ui-manage.asciidoc

docs/release-notes/8.3.asciidoc

Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>

banderror

Looks great, thank you! 👍

benironside

Looks great, left two minor suggestions

benironside · 2022-08-24T10:36:12Z

docs/detections/rules-ui-manage.asciidoc

+[role="screenshot"]
+image::images/rules-table-related-integrations.png[Rules table with related integrations popup,75%]
+
+TIP: You can hide the related integrations badge in the Rules tables. Go to *{kib}* -> *Stack Management* -> *Advanced Settings*, then turn off `securitySolution:showRelatedIntegrations`.


maybe do "related integrations" with a capital at the beginning, or in code text

I think just "integrations" to match the UI text, and bold because it's a UI label the user clicks, not text they enter.

I'll change this in a separate comment, so I can include the reference to the badge in line 97 above too.

benironside · 2022-08-24T10:37:56Z

docs/getting-started/advanced-setting.asciidoc

+[[show-related-integrations]]
+== Show/hide related integrations in Rules page tables
+
+By default, Elastic prebuilt rules in the *Rules* and *Rule Monitoring* tables include a badge showing how many related integrations have been installed. Turn off `securitySolution:showRelatedIntegrations` to hide this in the rules tables (related integrations will still appear on rule details pages).


maybe link to advanced settings here?

@benironside This text is already on the advanced settings page. Do you mean add a link somewhere else that points TO this section?

docs/detections/rules-ui-manage.asciidoc

docs/release-notes/8.3.asciidoc

…red Fields, and Setup (#2069) * Add new section to Advanced Settings * Update page's mini-TOC * Re-adds RNs for 132409 and 131475 * Revise advanced setting description * Create new section for related integrations etc. Includes placeholder image syntax, commented out * Add fields to API response examples * Update release notes * Add new section to What's New Includes placeholder image syntax, commented out * Additional revisions * Complete main documentation Add and update screenshots Revise explanatory text * Update release notes and What's New * Revert changes to whats-new.asciidoc What's new 8.3 will be updated in PR security-docs#2327 * Update per new nav UI * Apply suggestions from Nastasha's review Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> * Apply suggestions from Ben's review * Update docs/release-notes/8.3.asciidoc Co-authored-by: nastasha.solomon <nastasha.solomon@elastic.co> Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 953f781)

…red Fields, and Setup (#2069) * Add new section to Advanced Settings * Update page's mini-TOC * Re-adds RNs for 132409 and 131475 * Revise advanced setting description * Create new section for related integrations etc. Includes placeholder image syntax, commented out * Add fields to API response examples * Update release notes * Add new section to What's New Includes placeholder image syntax, commented out * Additional revisions * Complete main documentation Add and update screenshots Revise explanatory text * Update release notes and What's New * Revert changes to whats-new.asciidoc What's new 8.3 will be updated in PR security-docs#2327 * Update per new nav UI * Apply suggestions from Nastasha's review Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> * Apply suggestions from Ben's review * Update docs/release-notes/8.3.asciidoc Co-authored-by: nastasha.solomon <nastasha.solomon@elastic.co> Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 953f781) # Conflicts: # docs/detections/api/rules/rules-api-bulk-actions.asciidoc # docs/detections/images/all-rules.png # docs/detections/images/monitor-table.png

…red Fields, and Setup (#2069) (#2385) * Add new section to Advanced Settings * Update page's mini-TOC * Re-adds RNs for 132409 and 131475 * Revise advanced setting description * Create new section for related integrations etc. Includes placeholder image syntax, commented out * Add fields to API response examples * Update release notes * Add new section to What's New Includes placeholder image syntax, commented out * Additional revisions * Complete main documentation Add and update screenshots Revise explanatory text * Update release notes and What's New * Revert changes to whats-new.asciidoc What's new 8.3 will be updated in PR security-docs#2327 * Update per new nav UI * Apply suggestions from Nastasha's review Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> * Apply suggestions from Ben's review * Update docs/release-notes/8.3.asciidoc Co-authored-by: nastasha.solomon <nastasha.solomon@elastic.co> Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 953f781) Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

… Required Fields, and Setup (backport #2069) (#2386) * [DOCS] New rule fields for prerequisites: Related Integrations, Required Fields, and Setup (#2069) * Add new section to Advanced Settings * Update page's mini-TOC * Re-adds RNs for 132409 and 131475 * Revise advanced setting description * Create new section for related integrations etc. Includes placeholder image syntax, commented out * Add fields to API response examples * Update release notes * Add new section to What's New Includes placeholder image syntax, commented out * Additional revisions * Complete main documentation Add and update screenshots Revise explanatory text * Update release notes and What's New * Revert changes to whats-new.asciidoc What's new 8.3 will be updated in PR security-docs#2327 * Update per new nav UI * Apply suggestions from Nastasha's review Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> * Apply suggestions from Ben's review * Update docs/release-notes/8.3.asciidoc Co-authored-by: nastasha.solomon <nastasha.solomon@elastic.co> Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 953f781) # Conflicts: # docs/detections/api/rules/rules-api-bulk-actions.asciidoc # docs/detections/images/all-rules.png # docs/detections/images/monitor-table.png * Remove dry run example from 8.4 Hopefully this resolves merge conflict Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

Add new section to Advanced Settings

9c51cbc

joepeeples added enhancement New feature or request Team: Docs Team: Detections/Response Detections and Response API v8.3.0 Team: Security Solution Feature: Rules labels Jun 13, 2022

joepeeples self-assigned this Jun 13, 2022

joepeeples added 2 commits June 13, 2022 14:41

Update page's mini-TOC

c6f922e

Merge branch 'main' into issue-2015-related-int-required-fields-setup

40d690c

Merge branch 'main' into issue-2015-related-int-required-fields-setup

a2cb3dc

joepeeples mentioned this pull request Jun 29, 2022

[DOCS] New Rule fields: Related Integrations, Required Fields and Setup feature information is not available #2170

Closed

Merge branch 'main' into issue-2015-related-int-required-fields-setup

445ad4b

joepeeples changed the title ~~[DOCS] New Rule fields: Related Integrations, Required Fields, and Setup~~ [DOCS] New Rule fields: Related Integrations, Required Fields, and Setup - WIP Jun 29, 2022

joepeeples changed the title ~~[DOCS] New Rule fields: Related Integrations, Required Fields, and Setup - WIP~~ [DOCS] [WIP] New Rule fields: Related Integrations, Required Fields, and Setup Jun 29, 2022

joepeeples and others added 11 commits June 30, 2022 10:13

Merge branch 'main' into issue-2015-related-int-required-fields-setup

0510f73

Re-adds RNs for 132409 and 131475

3c05f5c

Revise advanced setting description

6ad45e3

Create new section for related integrations etc.

586b301

Includes placeholder image syntax, commented out

Add fields to API response examples

bb751a5

Update release notes

93cd003

Add new section to What's New

8a58cd2

Includes placeholder image syntax, commented out

Merge branch 'main' into issue-2015-related-int-required-fields-setup

85a8409

Additional revisions

29dd38b

Merge branch 'main' into issue-2015-related-int-required-fields-setup

34d6992

Merge branch 'main' into issue-2015-related-int-required-fields-setup

2b0162f

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into issue-2015-related-int-required-fields-setup

6cfa822

joepeeples added readyforQA PRs that are ready for QA review. and removed readyforQA PRs that are ready for QA review. labels Aug 22, 2022

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into issue-2015-related-int-required-fields-setup

f8fad08

This comment was marked as resolved.

Sign in to view

joepeeples added 3 commits August 23, 2022 11:50

Merge branch 'main' into issue-2015-related-int-required-fields-setup

5948aeb

Merge branch 'main' into issue-2015-related-int-required-fields-setup

f76644e

Merge branch 'main' into issue-2015-related-int-required-fields-setup

726763b

banderror reviewed Aug 23, 2022

View reviewed changes

joepeeples added 2 commits August 23, 2022 15:40

Merge branch 'main' into issue-2015-related-int-required-fields-setup

f449fb3

Update per new nav UI

43ac611

nastasha-solomon approved these changes Aug 23, 2022

View reviewed changes

docs/detections/rules-ui-manage.asciidoc Outdated Show resolved Hide resolved

docs/release-notes/8.3.asciidoc Outdated Show resolved Hide resolved

Apply suggestions from Nastasha's review

1b0a027

Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com>

banderror approved these changes Aug 24, 2022

View reviewed changes

benironside approved these changes Aug 24, 2022

View reviewed changes

joepeeples commented Aug 24, 2022

View reviewed changes

docs/detections/rules-ui-manage.asciidoc Outdated Show resolved Hide resolved

Apply suggestions from Ben's review

62135cc

joepeeples commented Aug 25, 2022

View reviewed changes

docs/release-notes/8.3.asciidoc Outdated Show resolved Hide resolved

Update docs/release-notes/8.3.asciidoc

8bcf023

joepeeples mentioned this pull request Aug 25, 2022

[DOCS] Prebuilt rules prerequisites: Update Release Notes and What's New in 8.4 #2384

Merged

Merge branch 'main' into issue-2015-related-int-required-fields-setup

cc7ab89

joepeeples merged commit 953f781 into main Aug 25, 2022

mergify bot mentioned this pull request Aug 25, 2022

[8.4] [DOCS] New rule fields for prerequisites: Related Integrations, Required Fields, and Setup (backport #2069) #2385

Merged

mergify bot mentioned this pull request Aug 25, 2022

[8.3] [DOCS] New rule fields for prerequisites: Related Integrations, Required Fields, and Setup (backport #2069) #2386

Merged

joepeeples deleted the issue-2015-related-int-required-fields-setup branch August 25, 2022 18:42

joepeeples mentioned this pull request Sep 19, 2022

[DOCS] Update documentation to include the new Rule fields: Related Integrations, Required Fields and Setup #2015

Closed

7 tasks

		* Adds new fields to prebuilt detection rules' schemas: `related_integrations`, `required_fields`, and `setup` ({pull}132409[#132409]).
		* Adds Related integrations, Required fields, and Setup guide sections to the rule details page, to help users identify, install, and configure a rule's prerequisites. Also adds related integrations badge to the rules table ({pull}131475[#131475]). Content for these new sections is delivered in a prebuilt rules update, independent of {stack} release versioning.

[DOCS] New rule fields for prerequisites: Related Integrations, Required Fields, and Setup #2069

[DOCS] New rule fields for prerequisites: Related Integrations, Required Fields, and Setup #2069

Uh oh!

Conversation

joepeeples commented Jun 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Joe's Li'l Checklist

Uh oh!

joepeeples commented Jun 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

banderror Aug 23, 2022

Choose a reason for hiding this comment

Uh oh!

joepeeples Aug 23, 2022

Choose a reason for hiding this comment

Uh oh!

nastasha-solomon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

banderror left a comment

Choose a reason for hiding this comment

Uh oh!

benironside left a comment

Choose a reason for hiding this comment

Uh oh!

benironside Aug 24, 2022

Choose a reason for hiding this comment

Uh oh!

joepeeples Aug 24, 2022

Choose a reason for hiding this comment

Uh oh!

benironside Aug 24, 2022

Choose a reason for hiding this comment

Uh oh!

joepeeples Aug 24, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

joepeeples commented Jun 13, 2022 •

edited

Loading

joepeeples commented Jun 28, 2022 •

edited

Loading