Skip to content

[Alerting][Docs] Reformatting rule types docs#101420

Merged
ymao1 merged 10 commits intoelastic:masterfrom
ymao1:alerting/restructure-docs-2
Jun 15, 2021
Merged

[Alerting][Docs] Reformatting rule types docs#101420
ymao1 merged 10 commits intoelastic:masterfrom
ymao1:alerting/restructure-docs-2

Conversation

@ymao1
Copy link
Contributor

@ymao1 ymao1 commented Jun 4, 2021 •
edited
Loading

Relates to #97657

Summary

1/3 PRs to address some alerting docs changes suggested by @gchaps. Summary of all proposed changes described here

This PR combines the Stack rules & Domain rules pages into a single Rule types page and formats the overview of rule types into a table.

Link to docs preview for rule types page: https://kibana_101420.docs-preview.app.elstc.co/guide/en/kibana/master/rule-types.html

@ymao1 ymao1 linked an issue Jun 4, 2021 that may be closed by this pull request
[Alerting] [Docs] Improve alerting documents formatting and combine managing rules related docs. #97657
Closed
@ymao1 ymao1 self-assigned this Jun 4, 2021
@ymao1 ymao1 added docs Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v7.14.0 v8.0.0 labels Jun 4, 2021
@ymao1 ymao1 marked this pull request as ready for review June 4, 2021 18:46
@ymao1 ymao1 requested a review from a team as a code owner June 4, 2021 18:46
@elasticmachine
Copy link
Contributor

elasticmachine commented Jun 4, 2021

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@ymao1 ymao1 requested a review from gchaps June 4, 2021 18:46
@ymao1 ymao1 mentioned this pull request Jun 4, 2021
Closed
YulNaumenko
YulNaumenko approved these changes Jun 8, 2021
View reviewed changes
Copy link
Contributor

@YulNaumenko YulNaumenko left a comment

Choose a reason for hiding this comment

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

LGTM

gchaps
gchaps reviewed Jun 14, 2021
View reviewed changes
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

This might be for another PR, but the Geo Alert page confused me. It starts with this line:

Alerting now includes one additional stack rule: Tracking containment. Is it a stack rule or domain rule? Is it called a geo alert or a tracking containment alert?

It would be nice for this page to be consistent with index threshold alert and Elasticsearch query alert.

ymao1 and others added 3 commits June 14, 2021 14:11
@ymao1 @gchaps
Apply suggestions from code review
223a186 
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@ymao1
Restructure geo rule page
844e289
@ymao1
Merge branch 'master' of https://github.com/elastic/kibana into alert…
789d68f 
…ing/restructure-docs-2
@ymao1
Copy link
Contributor Author

ymao1 commented Jun 14, 2021

This might be for another PR, but the Geo Alert page confused me. It starts with this line:

Alerting now includes one additional stack rule: Tracking containment. Is it a stack rule or domain rule? Is it called a geo alert or a tracking containment alert?

It would be nice for this page to be consistent with index threshold alert and Elasticsearch query alert.

@gchaps I reformatted the geo rule page to better follow the other stack rule type pages.

@ymao1 ymao1 requested a review from gchaps June 14, 2021 18:33
gchaps
gchaps approved these changes Jun 14, 2021
View reviewed changes
ymao1 and others added 3 commits June 14, 2021 19:51
@ymao1 @gchaps
Apply suggestions from code review
08b3c7a 
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@ymao1
PR fixes
fa1e5a7
@ymao1
Merge branch 'alerting/restructure-docs-2' of https://github.com/ymao…
d31b61d 
…1/kibana into alerting/restructure-docs-2
@ymao1 ymao1 added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 15, 2021
@ymao1 ymao1 merged commit 61602fe into elastic:master Jun 15, 2021
@ymao1 ymao1 mentioned this pull request Jun 15, 2021
Merged
@kibanamachine kibanamachine mentioned this pull request Jun 15, 2021
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 15, 2021
@ymao1 @gchaps @kibanamachine
[Alerting][Docs] Reformatting rule types docs (elastic#101420)
b186b13 
* Reformatting rule types docs

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Restructure geo rule page

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@kibanamachine
Copy link
Contributor

kibanamachine commented Jun 15, 2021

💚 Backport successful

Status Branch Result
✅ 7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Jun 15, 2021
@kibanamachine @ymao1 @gchaps
[Alerting][Docs] Reformatting rule types docs (#101420) (#102148)
4be51ee 
* Reformatting rule types docs

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Restructure geo rule page

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
cuff-links pushed a commit to cuff-links/kibana that referenced this pull request Jun 15, 2021
@ymao1 @gchaps
[Alerting][Docs] Reformatting rule types docs (elastic#101420)
8960780 
* Reformatting rule types docs

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Restructure geo rule page

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@YulNaumenko YulNaumenko YulNaumenko approved these changes

+1 more reviewer

@gchaps gchaps gchaps approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@ymao1 ymao1

Labels

auto-backport Deprecated - use backport:version if exact versions are needed docs Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v7.14.0 v8.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Alerting] [Docs] Improve alerting documents formatting and combine managing rules related docs.

5 participants

@ymao1 @elasticmachine @kibanamachine @gchaps @YulNaumenko