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

Alert types doc update #80632

Closed
arisonl opened this issue Oct 15, 2020 · 2 comments · Fixed by #91787
Closed

Alert types doc update #80632

arisonl opened this issue Oct 15, 2020 · 2 comments · Fixed by #91787
Assignees
Labels
Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@arisonl
Copy link
Contributor

arisonl commented Oct 15, 2020

There are a few issues with the opening paragraph of the 'Alert Types' document that we may want to address:

  • Terminology for framework-level alerts: The term built-in alerts is used and it is likely that this term is a bit esoteric. In addition, in feature controls (subsequent release) we have named "built-in alerts" as stack alerts and we should probably stay consistent here.
  • References to solution-specific alerts: We currently include links to solutions for the solution-specific types, but:
    • The links lead to generic pages, rather than the Observability alert pages, so the user needs to search through in order to discover the non-framework types. Even worse, it may cause some users to think that we only offer the alert types explicitly discussed in this page (i.e. the index threshold alert). Which leads to the next point:
    • The message should be clearer that more alert types are linked through this page. Particularly, because the page is titled "Alert Types" and it currently covers how to create an index threshold alert (in the absence of other framework-level alerts).

Let's also discuss if there is a viable way to keep all alert types in one place, although links are the best way to maintain always updated documentation. Also, let's make sure that any updates/changes we decide, propagate to other related pages accordingly.

@arisonl arisonl added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) :Alerting Project:Alerting labels Oct 15, 2020
@elasticmachine
Copy link
Contributor

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

@bmcconaghy
Copy link
Contributor

@arisonl the docs have been updated to refer to these as "stack alerts" consistently. As for the other points, don't really see any way around this. We don't want to maintain docs for other alert types outside the docs for the apps that add them, so I think linking is the way to go. We need the maps team to add their own docs for the geo alert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
5 participants