renaming built-in alerts to Stack Alerts#82873
Merged
bmcconaghy merged 3 commits intoelastic:masterfrom Nov 10, 2020
Merged
Conversation
gchaps
reviewed
Nov 6, 2020
| == Alert types | ||
|
|
||
| {kib} supplies alerts types in two ways: some are built into {kib}, while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>. | ||
| {kib} supplies alerts types in two ways: some are built into {kib} (these are known as *Stack Alerts*), while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>. |
Contributor
There was a problem hiding this comment.
We use caps and bold for names of apps and features. For stack alerts, I recommend lowercase and regular font. Here is a suggestion for the intro sentence:
Kibana supplies two types of alerts: stack alerts, which are built into Kibana, and domain-specific alerts, which are registered by Kibana apps such as APM, Metrics, and Uptime.
| {kib} supplies alerts types in two ways: some are built into {kib} (these are known as *Stack Alerts*), while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>. | ||
|
|
||
| This section covers built-in alert types. For domain-specific alert types, refer to the documentation for that app. | ||
| This section covers *Stack Alert* types. For domain-specific alert types, refer to the documentation for that app. |
Contributor
There was a problem hiding this comment.
Can we drop the word "types"?
This section covers stack alerts. For domain-specific alerts, refer to the documentation for that app.
| This section covers *Stack Alert* types. For domain-specific alert types, refer to the documentation for that app. | ||
|
|
||
| Currently {kib} provides one built-in alert type: the <<alert-type-index-threshold>> type. | ||
| Currently {kib} provides one *Stack Alert* type: the <<alert-type-index-threshold>> type. |
Contributor
There was a problem hiding this comment.
Currently Kibana provides one stack alert: index threshold.
Contributor
Author
There was a problem hiding this comment.
I think that makes sense but I want to preserve the caps/bold since that is the name of the feature in RBAC.
| -- | ||
|
|
||
| Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, <<xpack-siem,*Security*>>, <<uptime-app,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use. | ||
| Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, <<xpack-siem,*Security*>>, <<uptime-app,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> (known as *Stack Alerts*) for you to use. |
Contributor
There was a problem hiding this comment.
I don't think "(known as stack alerts)" is needed here. The link takes you to a page that explains the different types of alerts.
We should add the terms "stack alert" and "domain-specific alert" to the glossary.
Contributor
Author
There was a problem hiding this comment.
I want to hammer on the terminology here since it is related to RBAC. Putting it in the glossary kind of buries it.
gchaps
approved these changes
Nov 9, 2020
Contributor
gchaps
left a comment
There was a problem hiding this comment.
LGTM with one minor change.
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
bmcconaghy
added a commit
to bmcconaghy/kibana
that referenced
this pull request
Nov 10, 2020
* renaming built-in alerts to Stack Alerts * responding to PR feedback and adding glossary definition for stack alerts * Update docs/glossary.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
bmcconaghy
added a commit
that referenced
this pull request
Nov 10, 2020
* renaming built-in alerts to Stack Alerts * responding to PR feedback and adding glossary definition for stack alerts * Update docs/glossary.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
bmcconaghy
added a commit
that referenced
this pull request
Nov 10, 2020
* renaming built-in alerts to Stack Alerts * responding to PR feedback and adding glossary definition for stack alerts * Update docs/glossary.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
phillipb
added a commit
to phillipb/kibana
that referenced
this pull request
Nov 10, 2020
…kibana into bootstrap-node-details-overlay * 'bootstrap-node-details-overlay' of github.com:phillipb/kibana: (49 commits) [Security Solution] Fix DNS Network table query (elastic#82778) [Workplace Search] Consolidate groups routes (elastic#83015) Adds cloud links to user menu (elastic#82803) [Security Solution][Detections] - follow up cleanup on auto refresh rules (elastic#83023) [App Search] Added the log retention panel to the Settings page (elastic#82982) [Maps] show icon when layer is filtered by time and allow layers to ignore global time range (elastic#83006) [DOCS] Consolidates drilldown pages (elastic#82081) [Maps] add on-prem EMS config (elastic#82525) migrate i18n mixin to KP (elastic#81799) [bundle optimization] fix imports of react-use lib (elastic#82847) [Discover] Add metric on adding filter (elastic#82961) [Lens] Performance refactoring for indexpattern fast lookup and Operation support matrix computation (elastic#82829) skip flaky suite (elastic#82804) Fix SO query for searching across spaces (elastic#83025) renaming built-in alerts to Stack Alerts (elastic#82873) [TSVB] Disable using top_hits in pipeline aggregations (elastic#82278) [Visualizations] Remove kui usage (elastic#82810) [Visualizations] Make the icon buttons labels more descriptive (elastic#82585) [Lens] Do not reset formatting when switching between custom ranges and auto histogram (elastic#82694) Fix ilm navigation (elastic#81664) ...
gmmorris
added a commit
to gmmorris/kibana
that referenced
this pull request
Nov 10, 2020
…na into alerts/stack-alerts-public * 'alerts/stack-alerts-public' of github.com:gmmorris/kibana: [Security Solution] Fix DNS Network table query (elastic#82778) [Workplace Search] Consolidate groups routes (elastic#83015) Adds cloud links to user menu (elastic#82803) [Security Solution][Detections] - follow up cleanup on auto refresh rules (elastic#83023) [App Search] Added the log retention panel to the Settings page (elastic#82982) [Maps] show icon when layer is filtered by time and allow layers to ignore global time range (elastic#83006) [DOCS] Consolidates drilldown pages (elastic#82081) [Maps] add on-prem EMS config (elastic#82525) migrate i18n mixin to KP (elastic#81799) [bundle optimization] fix imports of react-use lib (elastic#82847) [Discover] Add metric on adding filter (elastic#82961) [Lens] Performance refactoring for indexpattern fast lookup and Operation support matrix computation (elastic#82829) skip flaky suite (elastic#82804) Fix SO query for searching across spaces (elastic#83025) renaming built-in alerts to Stack Alerts (elastic#82873) [TSVB] Disable using top_hits in pipeline aggregations (elastic#82278) [Visualizations] Remove kui usage (elastic#82810) [Visualizations] Make the icon buttons labels more descriptive (elastic#82585) [Lens] Do not reset formatting when switching between custom ranges and auto histogram (elastic#82694) :
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR goes through existing documentation and swaps out the old "built-in alerts" terminology for the new terminology (Stack Alerts). It also tries to socialize the transition by still referring to alerts as being built-in while still referring to them by the new name.