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

[8.16] Manual rule run docs #5631

Merged
merged 21 commits into from
Oct 16, 2024
Merged

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Jul 30, 2024

Contributes to #5264

ESS Previews

  • Manage detection rules | Run rules manually: New section
  • Made the following changes to the "Monitor and troubleshoot rule executions" page:
    • Execution results: Updated intro and added new list items to describe the new filter and toggle added to the Execution log table.
    • Added a new section to explain the new Manual runs table.
  • Bulk action API doc updates:
    • Request body - Made two changes:
      • Added the run value to the list of possible values for the action param.
      • Doc'd a new param named run
    • BulkManualRuleRun object - New section that shows how to edit the BulkManualRuleRun[] object.
    • BulkEditAction object | Response payload - Updated the list of actions that can be included in the response payload and refreshed the description for the attributes.results.updated field.
  • Alert schema - Added a description for the new kibana.alert.intended_timestamp alert field.

Corresponding Serverless PR: #5589

@nastasha-solomon nastasha-solomon added Feature: Rules Team: Detection Engine Priority: Medium Issues that have relevance, but aren't urgent Effort: Medium Issues that take moderate but not substantial time to complete Docset: ESS Issues that apply to docs in the Stack release v8.16.0 labels Jul 30, 2024
@nastasha-solomon nastasha-solomon self-assigned this Jul 30, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@nastasha-solomon nastasha-solomon marked this pull request as ready for review September 19, 2024 18:25
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner September 19, 2024 18:25
@nastasha-solomon nastasha-solomon merged commit 64d64d7 into main Oct 16, 2024
3 checks passed
@nastasha-solomon nastasha-solomon deleted the issue-5264-8.16-manual-rule-run branch October 16, 2024 15:14
mergify bot pushed a commit that referenced this pull request Oct 16, 2024
* First draft

* Removing ESS text changes

* just kidding - wrong branch stash

* Fixed typo

* Limitations and new field

* Removing content

* Fix table

* Updates note

* Update docs/detections/rules-ui-manage.asciidoc

* Update docs/detections/rules-ui-manage.asciidoc

* Update docs/detections/rules-ui-manage.asciidoc

* Update docs/detections/rules-ui-monitor.asciidoc

* Update docs/detections/rules-ui-monitor.asciidoc

* Update docs/reference/alert-schema.asciidoc

* Fixed path

* Editorial feedback

* Removes unecessary term

(cherry picked from commit 64d64d7)
nastasha-solomon added a commit that referenced this pull request Oct 16, 2024
* First draft

* Removing ESS text changes

* just kidding - wrong branch stash

* Fixed typo

* Limitations and new field

* Removing content

* Fix table

* Updates note

* Update docs/detections/rules-ui-manage.asciidoc

* Update docs/detections/rules-ui-manage.asciidoc

* Update docs/detections/rules-ui-manage.asciidoc

* Update docs/detections/rules-ui-monitor.asciidoc

* Update docs/detections/rules-ui-monitor.asciidoc

* Update docs/reference/alert-schema.asciidoc

* Fixed path

* Editorial feedback

* Removes unecessary term

(cherry picked from commit 64d64d7)

Co-authored-by: Nastasha Solomon <[email protected]>
@nastasha-solomon nastasha-solomon mentioned this pull request Nov 7, 2024
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docset: ESS Issues that apply to docs in the Stack release Effort: Medium Issues that take moderate but not substantial time to complete Feature: Rules Priority: Medium Issues that have relevance, but aren't urgent Team: Detection Engine v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants