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.

Sign up for GitHub

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

renaming built-in alerts to Stack Alerts #82873

Merged
merged 3 commits into from
Nov 10, 2020
+11 −4
Merged

renaming built-in alerts to Stack Alerts #82873

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5a83c6
renaming built-in alerts to Stack Alerts
bmcconaghy Nov 6, 2020
f02182e
responding to PR feedback and adding glossary definition for stack al…
bmcconaghy Nov 9, 2020
a067a33
Update docs/glossary.asciidoc
bmcconaghy Nov 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/user/alerting/alert-types.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
[[alert-types]]
== 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*>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.


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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we drop the word "types"?

This section covers stack alerts. For domain-specific alerts, 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Currently Kibana provides one stack alert: index threshold.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that makes sense but I want to preserve the caps/bold since that is the name of the feature in RBAC.


[float]
[[alert-type-index-threshold]]
Expand Down
2 changes: 1 addition & 1 deletion docs/user/alerting/alerting-getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ beta[]

--

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I want to hammer on the terminology here since it is related to RBAC. Putting it in the glossary kind of buries it.


image::images/alerting-overview.png[Alerts and actions UI]

Expand Down