You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We cover alerting rules in multiple places across the Elastic docs, but we aren't very consistent in structure or content. Now that we have serverless docs, too, we have yet another style/structure that is inconsistent. It's confusing to users when they see content that is very similar (has essentially the same steps) but is out-of-sync and follows a different format. It's also hard for Observability users to find documentation about all the types of rules they can create when they need to go to more than one place (like they do in the stateful obs docs).
For example, here are existing docs about creating and managing rules:
Here's what I think we need to do, but we should collaborate on a plan:
In the stateful obs docs, organize all the rules under one section (like we do in serverless), so users can see all rules that are available for observability.
Make sure users are able to scan the TOC and see all the rules they can create: Elasticsearch query, SLO burn rate, APM Anomaly, Error count threshold, Failed transaction rate threshold, Latency threshold, Log threshold, Inventory, Metric threshold, Custom threshold, etc.
Make the serverless and stateful alerting docs more consistent in content and structure.
Consider standardizing on a template for documenting rules so that we are consistent across the various docs that talk about creating rules.
Resources
n/a
Which documentation set does this change impact?
Stateful and Serverless
Feature differences
n/a
What release is this request related to?
N/A
Collaboration model
The documentation team
Point of contact.
Main contact: TBD
Stakeholders:
The text was updated successfully, but these errors were encountered:
Description
We cover alerting rules in multiple places across the Elastic docs, but we aren't very consistent in structure or content. Now that we have serverless docs, too, we have yet another style/structure that is inconsistent. It's confusing to users when they see content that is very similar (has essentially the same steps) but is out-of-sync and follows a different format. It's also hard for Observability users to find documentation about all the types of rules they can create when they need to go to more than one place (like they do in the stateful obs docs).
For example, here are existing docs about creating and managing rules:
Here's what I think we need to do, but we should collaborate on a plan:
Resources
n/a
Which documentation set does this change impact?
Stateful and Serverless
Feature differences
n/a
What release is this request related to?
N/A
Collaboration model
The documentation team
Point of contact.
Main contact: TBD
Stakeholders:
The text was updated successfully, but these errors were encountered: