[Alerting][Docs] Combine rule creation and management pages by ymao1 · Pull Request #101498 · elastic/kibana

ymao1 · 2021-06-07T15:29:34Z

Summary

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

This PR combines the Defining Rules/Managing Rules/Rule details pages into single Create and Manage Rules page.

Docs link: https://kibana_101498.docs-preview.app.elstc.co/guide/en/kibana/master/create-and-manage-rules.html

…ing/restructure-docs-3

ymao1 · 2021-06-07T18:27:56Z

docs/user/alerting/defining-rules.asciidoc

-. <<defining-alerts-actions-details, Action type and action details>>
-
-image::images/rule-flyout-sections.png[The three sections of a rule definition]
+This content has been moved to <<create-and-manage-rules>>.


Had to leave this file and anchor link here temporarily to avoid bad cross-document link errors. When this PR is merged, I will create PRs in the obs and ML docs repos to update links in their docs, and then I will make another PR to clean up these placeholders.

ymao1 · 2021-06-07T18:28:35Z

docs/user/alerting/index.asciidoc

 include::alerting-getting-started.asciidoc[]
+include::create-and-manage-rules.asciidoc[]
 include::defining-rules.asciidoc[]
 include::rule-management.asciidoc[]


Same comment as above: will remove links to defining-rules and rule-management when bad cross document links are resolved.

ymao1 · 2021-06-07T18:28:49Z

docs/user/alerting/rule-management.asciidoc

-=== Required permissions
-
-Access to rules is granted based on your privileges to alerting-enabled features. See <<alerting-security, Alerting Security>> for more information.
+This content has been moved to <<create-and-manage-rules>>.


Same comment as above about cross document links.

elasticmachine · 2021-06-07T18:29:42Z

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

YulNaumenko

LGTM

docs/user/alerting/create-and-manage-rules.asciidoc

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

…ing/restructure-docs-3

docs/user/alerting/create-and-manage-rules.asciidoc

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

…ing/restructure-docs-3

ymao1 · 2021-06-09T11:51:19Z

@elasticmachine merge upstream

gchaps

Looks good. Some minor suggestions.

docs/user/alerting/create-and-manage-rules.asciidoc

kibanamachine · 2021-06-10T21:32:30Z

💚 Build Succeeded

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	410.5KB	410.5KB	+7.0B

History

💚 Build #130485 succeeded c920311
💚 Build #130085 succeeded cee6d04
💔 Build #129993 failed 493ae59
💚 Build #129975 succeeded 659d9e4
💛 Build #129611 was flaky 855300e

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @ymao1

…101498) * Combining rule management stuff into single page * Cleaning up image widths and header sizes * Adding in placeholder pages * Adding in placeholder pages * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * PR and test fixes * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * PR fixes * PR fixes Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-06-10T21:49:26Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…#101979) * Combining rule management stuff into single page * Cleaning up image widths and header sizes * Adding in placeholder pages * Adding in placeholder pages * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * PR and test fixes * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * PR fixes * PR fixes Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # docs/user/monitoring/kibana-alerts.asciidoc

* master: (68 commits) skip flaky suite (elastic#94043) skip flaky suite (elastic#102012) [esArchive] Persists updates for management/saved_objects/* (elastic#101992) skip flaky suite (elastic#101449) remove unnecessary hack (elastic#101909) [Exploratory View] Use human readable formats (elastic#101520) [Expressions] Refactor expression functions to use observables underneath (elastic#100409) [esArchives] Persist migrated Kibana archives (elastic#101950) [kbnArchiver] fix save to non-existent file (elastic#101974) [Enterprise Search] Add owner and description properties to kibana.json (elastic#101957) [DOCS] Fixes terminology in Stack Monitoring:Kibana alerts (elastic#101696) [Observability] [Cases] Cases in the observability app (elastic#101487) [Alerting][Docs] Combine rule creation and management pages (elastic#101498) temporarily disable build-buddy [Fleet] Fix fleet server collector in case settings are not set (elastic#101752) [Event Log] Populated rule.* ECS fields for alert events. (elastic#101132) [APM] Fleet support for merging input.config values with other nested properties in the policy input (elastic#101690) Add comments to some alerting plugin public API items (elastic#101551) [Alerting][Docs] Moving alerting setup to its own page (elastic#101323) remove uptime public API, it's not used. (elastic#101799) ...

ymao1 added 5 commits June 4, 2021 15:09

Combining rule management stuff into single page

0c6e301

Cleaning up image widths and header sizes

c24fe9c

Merge branch 'master' of https://github.com/elastic/kibana into alert…

34f096e

…ing/restructure-docs-3

Adding in placeholder pages

697640b

Adding in placeholder pages

601ff84

ymao1 linked an issue Jun 7, 2021 that may be closed by this pull request

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

Closed

ymao1 mentioned this pull request Jun 7, 2021

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

Closed

ymao1 commented Jun 7, 2021

View reviewed changes

ymao1 self-assigned this Jun 7, 2021

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 7, 2021

ymao1 marked this pull request as ready for review June 7, 2021 18:29

ymao1 requested review from a team as code owners June 7, 2021 18:29

pgayvallet approved these changes Jun 7, 2021

View reviewed changes

ymao1 requested a review from gchaps June 7, 2021 18:41

YulNaumenko approved these changes Jun 7, 2021

View reviewed changes

gchaps reviewed Jun 7, 2021

View reviewed changes

ymao1 and others added 3 commits June 7, 2021 16:04

Apply suggestions from code review

e355fc4

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

PR and test fixes

2c93360

Merge branch 'master' of https://github.com/elastic/kibana into alert…

855300e

…ing/restructure-docs-3

gchaps reviewed Jun 8, 2021

View reviewed changes

Apply suggestions from code review

659d9e4

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

ymao1 added 2 commits June 8, 2021 19:50

PR fixes

dc65ff3

Merge branch 'master' of https://github.com/elastic/kibana into alert…

493ae59

…ing/restructure-docs-3

ymao1 requested a review from gchaps June 8, 2021 23:52

kibanamachine and others added 2 commits June 9, 2021 07:51

Merge branch 'master' into alerting/restructure-docs-3

cee6d04

Merging in master

c920311

gchaps approved these changes Jun 10, 2021

View reviewed changes

docs/user/alerting/create-and-manage-rules.asciidoc Outdated Show resolved Hide resolved

docs/user/alerting/create-and-manage-rules.asciidoc Outdated Show resolved Hide resolved

ymao1 added 2 commits June 10, 2021 15:23

Merging in master

bb4c03f

PR fixes

97482fb

ymao1 added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 10, 2021

ymao1 mentioned this pull request Jun 10, 2021

[Docs] Update cross-document links to Kibana Alerting docs elastic/observability-docs#779

Merged

ymao1 merged commit b242765 into elastic:master Jun 10, 2021

kibanamachine mentioned this pull request Jun 10, 2021

[7.x] [Alerting][Docs] Combine rule creation and management pages (#101498) #101969

Closed

ymao1 mentioned this pull request Jun 11, 2021

[7.x] [Alerting][Docs] Combine rule creation and management pages (#101498) #101979

Merged

ymao1 mentioned this pull request Jun 14, 2021

[Docs] Update cross-document links to Kibana Alerting docs elastic/elasticsearch#74034

Merged

Conversation

ymao1 commented Jun 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

ymao1 Jun 7, 2021

Choose a reason for hiding this comment

Uh oh!

ymao1 Jun 7, 2021

Choose a reason for hiding this comment

Uh oh!

ymao1 Jun 7, 2021

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jun 7, 2021

Uh oh!

YulNaumenko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ymao1 commented Jun 9, 2021

Uh oh!

gchaps left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kibanamachine commented Jun 10, 2021

💚 Build Succeeded

Metrics [docs]

Page load bundle

History

Uh oh!

kibanamachine commented Jun 10, 2021

💚 Backport successful

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ymao1 commented Jun 7, 2021 •

edited

Loading