[Alerting][Docs] Adding template for documenting alert and action types #92830

ymao1 · 2021-02-25T15:43:07Z

Resolves #82000
Addresses item in #89999

Summary

Added asciidoc template under docs directory.
Ensured existing stack alert docs and action type docs conformed to template
Added text in alerts and actions README with pointers to the templates

Checklist

Documentation was added for features that require explanation or tutorials

ymao1 · 2021-02-25T16:11:47Z

docs/user/alerting/action-types/email.asciidoc

@@ -10,14 +10,15 @@ NOTE: For emails to have a footer with a link back to {kib}, set the <<server-pu
 [[email-connector-configuration]]
 ==== Connector configuration

-Email connectors have the following configuration properties:
+Email connectors have the following configuration properties.


Changed from : to . as per @gchaps suggestion

…ing/doc-template

elasticmachine · 2021-02-25T18:02:20Z

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

YulNaumenko

LGTM!

ymao1 · 2021-02-25T19:10:19Z

@elasticmachine merge upstream

… into alerting/doc-template

docs/user/alerting/action-types/email.asciidoc

docs/user/alerting/action-types/index.asciidoc

docs/action-type-template.asciidoc

docs/user/alerting/action-types/teams.asciidoc

docs/user/alerting/alert-types.asciidoc

docs/user/alerting/defining-alerts.asciidoc

docs/user/alerting/stack-alerts/es-query.asciidoc

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

ymao1 · 2021-03-01T12:45:35Z

@elasticmachine merge upstream

…ing/doc-template

docs/user/alerting/defining-alerts.asciidoc

docs/user/alerting/stack-alerts/es-query.asciidoc

docs/user/alerting/stack-alerts/index-threshold.asciidoc

x-pack/plugins/actions/README.md

…ing/doc-template

gchaps

A few minor comments, but otherwise LGTM.

docs/user/alerting/stack-alerts/es-query.asciidoc

docs/user/alerting/stack-alerts/index-threshold.asciidoc

docs/alert-type-template.asciidoc

kibanamachine · 2021-03-02T22:57:32Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`triggersActionsUi`	1.6MB	1.5MB	-23.9KB

Page load bundle

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

id	before	after	diff
`triggersActionsUi`	104.1KB	104.2KB	+82.0B

Unknown metric groups

async chunk count

id	before	after	diff
`triggersActionsUi`	41	42	+1

History

💚 Build #110508 succeeded 1f70e58
💚 Build #110282 succeeded 738cd45
💚 Build #110098 succeeded 167cc52
💚 Build #109876 succeeded 0f5e5c0
💚 Build #109777 succeeded 2fa86f7

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

cc @ymao1

kibanamachine · 2021-03-02T23:11:30Z

💔 Backport failed

❌ 7.12: Commit could not be cherrypicked due to conflicts
❌ 7.x: Commit could not be cherrypicked due to conflicts

To backport manually, check out the target branch and run:
node scripts/backport --pr 92830

…es (elastic#92830) * Alert type template * Action type template * Cleanup * Cleanup * Removing callout list * Cleanup * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Adding title to actions page * PR fixes * PR fixes * PR fixes * PR fixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # docs/user/alerting/defining-alerts.asciidoc

…es (elastic#92830) * Alert type template * Action type template * Cleanup * Cleanup * Removing callout list * Cleanup * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Adding title to actions page * PR fixes * PR fixes * PR fixes * PR fixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

…es (#92830) (#93348) * Alert type template * Action type template * Cleanup * Cleanup * Removing callout list * Cleanup * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Adding title to actions page * PR fixes * PR fixes * PR fixes * PR fixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

…es (#92830) (#93347) * Alert type template * Action type template * Cleanup * Cleanup * Removing callout list * Cleanup * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Adding title to actions page * PR fixes * PR fixes * PR fixes * PR fixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # docs/user/alerting/defining-alerts.asciidoc

* master: (45 commits) Add outcome of node scripts/build_api_docs (elastic#93399) [Lens] fix long field name on field stats panel doesn't wrap (elastic#93279) [Bug] Fix filter creation for numeric scripted fields in Discover (elastic#93224) [uptime] Fix anomaly alert edit (elastic#93025) Consolidate @babel/* packages and use latest compatible version (elastic#93264) [Search Embeddable] Add highlighting when searching (elastic#93178) [APM] Add missing bottom border to header (elastic#93179) [CI] No longer collect APM span stack traces (elastic#93263) [XY Chart] Fix "No data to display" error when using IP range aggregation to split series (elastic#93024) update generated public api docs API DOCS Step 3/3 (elastic#92929) chore(NA): look for bazel packages on npm_module folder during distributable build (elastic#93262) rename advanced setting ml:fileDataVisualizerMaxFileSize to fileUpload:maxFileSize and increase max geojson upload size to 1GB (elastic#92620) [kbn/optimizer] allow customizing the limits path from the script (elastic#93153) [Alerting][Docs] Adding template for documenting alert and action types (elastic#92830) [jenkins] convert baseline capture job to use tasks (elastic#93288) removing the linked issue in comments from PR (elastic#93303) chore(NA): do not include fs within a storybook build (elastic#93294) [Maps] Update Map extent queries to use bounding box logic for both point and shape queries (elastic#93156) Add searchDuration to EQL and Threshold rules (elastic#93149) ...

ymao1 added 2 commits February 25, 2021 08:43

Alert type template

0aa827f

Action type template

4222fc4

ymao1 changed the title ~~Alerting/doc template~~ [Alerting][Docs] Adding template for documenting alert and action types Feb 25, 2021

ymao1 self-assigned this Feb 25, 2021

ymao1 commented Feb 25, 2021

View reviewed changes

ymao1 added 4 commits February 25, 2021 11:37

Cleanup

5a332e8

Cleanup

7b9ee25

Removing callout list

cd216e3

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

bc3d3bf

…ing/doc-template

ymao1 added Feature:Actions Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.12.0 v7.13.0 v8.0.0 labels Feb 25, 2021

ymao1 marked this pull request as ready for review February 25, 2021 18:02

ymao1 requested a review from a team as a code owner February 25, 2021 18:02

ymao1 requested a review from gchaps February 25, 2021 18:02

ymao1 added this to In Review in Kibana Alerting Feb 25, 2021

ymao1 mentioned this pull request Feb 25, 2021

Alerting GA - General documentation #89999

Closed

5 tasks

YulNaumenko approved these changes Feb 25, 2021

View reviewed changes

kibanamachine and others added 4 commits February 25, 2021 14:10

Merge branch 'master' into alerting/doc-template

32afb94

Merging in master

625c0e8

Merge branch 'alerting/doc-template' of https://github.com/ymao1/kibana…

c1434ea

… into alerting/doc-template

Cleanup

bd3db14

gchaps reviewed Feb 27, 2021

View reviewed changes

Apply suggestions from code review

4988d06

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

ymao1 added 2 commits February 28, 2021 09:31

Adding title to actions page

99ecd2b

PR fixes

2fa86f7

kibanamachine and others added 4 commits March 1, 2021 07:45

Merge branch 'master' into alerting/doc-template

0f5e5c0

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

0987b59

…ing/doc-template

PR fixes

167cc52

Merging in master

738cd45

gchaps reviewed Mar 2, 2021

View reviewed changes

ymao1 added 3 commits March 2, 2021 14:36

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

5fe1783

…ing/doc-template

PR fixes

a0874ea

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

1f70e58

…ing/doc-template

ymao1 requested a review from gchaps March 2, 2021 20:18

gchaps approved these changes Mar 2, 2021

View reviewed changes

PR fixes

630f32b

ymao1 added the auto-backport Deprecated: Automatically backport this PR after it's merged label Mar 2, 2021

ymao1 merged commit fda67ad into elastic:master Mar 2, 2021

Kibana Alerting automation moved this from In Review to Done (Ordered by most recent) Mar 2, 2021

ymao1 mentioned this pull request Mar 2, 2021

[7.x] [Alerting][Docs] Adding template for documenting alert and action types (#92830) #93347

Merged

ymao1 mentioned this pull request Mar 2, 2021

[7.12] [Alerting][Docs] Adding template for documenting alert and action types (#92830) #93348

Merged

ymao1 deleted the alerting/doc-template branch March 25, 2021 14:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting][Docs] Adding template for documenting alert and action types #92830

[Alerting][Docs] Adding template for documenting alert and action types #92830

ymao1 commented Feb 25, 2021 •

edited

Loading

ymao1 Feb 25, 2021

elasticmachine commented Feb 25, 2021

YulNaumenko left a comment

ymao1 commented Feb 25, 2021

ymao1 commented Mar 1, 2021

gchaps left a comment

kibanamachine commented Mar 2, 2021

async chunk count

kibanamachine commented Mar 2, 2021

[Alerting][Docs] Adding template for documenting alert and action types #92830

[Alerting][Docs] Adding template for documenting alert and action types #92830

Conversation

ymao1 commented Feb 25, 2021 • edited Loading

Summary

Checklist

ymao1 Feb 25, 2021

Choose a reason for hiding this comment

elasticmachine commented Feb 25, 2021

YulNaumenko left a comment

Choose a reason for hiding this comment

ymao1 commented Feb 25, 2021

ymao1 commented Mar 1, 2021

gchaps left a comment

Choose a reason for hiding this comment

kibanamachine commented Mar 2, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

async chunk count

History

kibanamachine commented Mar 2, 2021

💔 Backport failed

ymao1 commented Feb 25, 2021 •

edited

Loading