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

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

Merged
merged 21 commits into from
Mar 2, 2021

Conversation

ymao1
Copy link
Contributor

@ymao1 ymao1 commented Feb 25, 2021

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 ymao1 changed the title Alerting/doc template [Alerting][Docs] Adding template for documenting alert and action types Feb 25, 2021
@ymao1 ymao1 self-assigned this Feb 25, 2021
@@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed from : to . as per @gchaps suggestion

@ymao1 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 ymao1 marked this pull request as ready for review February 25, 2021 18:02
@ymao1 ymao1 requested a review from a team as a code owner February 25, 2021 18:02
@elasticmachine
Copy link
Contributor

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

@ymao1 ymao1 requested a review from gchaps February 25, 2021 18:02
@ymao1 ymao1 mentioned this pull request Feb 25, 2021
5 tasks
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!

@ymao1
Copy link
Contributor Author

ymao1 commented Feb 25, 2021

@elasticmachine merge upstream

docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/action-type-template.asciidoc Show resolved Hide resolved
docs/user/alerting/alert-types.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/defining-alerts.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/defining-alerts.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@ymao1
Copy link
Contributor Author

ymao1 commented Mar 1, 2021

@elasticmachine merge upstream

docs/user/alerting/defining-alerts.asciidoc Show resolved Hide resolved
docs/user/alerting/stack-alerts/es-query.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/stack-alerts/es-query.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/stack-alerts/es-query.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/stack-alerts/es-query.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/stack-alerts/index-threshold.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/stack-alerts/index-threshold.asciidoc Outdated Show resolved Hide resolved
x-pack/plugins/actions/README.md Outdated Show resolved Hide resolved
@ymao1 ymao1 requested a review from gchaps March 2, 2021 20:18
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.

A few minor comments, but otherwise LGTM.

docs/user/alerting/stack-alerts/es-query.asciidoc Outdated Show resolved Hide resolved
docs/alert-type-template.asciidoc Outdated Show resolved Hide resolved
@kibanamachine
Copy link
Contributor

💚 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

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

cc @ymao1

@ymao1 ymao1 added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 2, 2021
@ymao1 ymao1 merged commit fda67ad into elastic:master Mar 2, 2021
@kibanamachine
Copy link
Contributor

💔 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

ymao1 added a commit to ymao1/kibana that referenced this pull request Mar 2, 2021
…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
ymao1 added a commit to ymao1/kibana that referenced this pull request Mar 2, 2021
…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>
ymao1 added a commit that referenced this pull request Mar 3, 2021
…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>
ymao1 added a commit that referenced this pull request Mar 3, 2021
…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
gmmorris added a commit to gmmorris/kibana that referenced this pull request Mar 3, 2021
* 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 ymao1 deleted the alerting/doc-template branch March 25, 2021 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation template for alert and action types
5 participants