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

[REQUEST] Alerting Documentation Improvements #2605

Closed
emma-raffenne opened this issue Nov 9, 2022 · 2 comments
Closed

[REQUEST] Alerting Documentation Improvements #2605

emma-raffenne opened this issue Nov 9, 2022 · 2 comments
Assignees
Labels
Area:ActionableObs classic-docs Team:Docs Label for the Observability docs team

Comments

@emma-raffenne
Copy link

Context

This is related to the o11y alerting documentation included in the Observability guide:

It is NOT related to the Alerting section of the Kibana guide that corresponds the foundational alerting services provided by the stack (ResponseOps team from Platform).

Proposed Improvements

  • Structure the Alerting documentation starting with an introduction as entry page and separate pages for each feature (rules, alerts) so new pages can be added as new features are being delivered and the user can find their way according to what they try to achieve.
  • Separate o11y alerting services documentation from app specific features, e.g. creation of rule per rule type.
  • Cross-link app specific features documentation from/to alerting and the corresponding app documentation
  • Provide content oriented to best practices and use cases our users can relate to
@ollyhowell ollyhowell removed their assignment Dec 12, 2022
@emma-raffenne emma-raffenne changed the title Alerting Documentation Improvements [REQUEST] Alerting Documentation Improvements Feb 10, 2023
@emma-raffenne emma-raffenne transferred this issue from elastic/kibana Feb 10, 2023
@dedemorton
Copy link
Contributor

Some of these changes were made in the serverless docs, but never made it back into the classic/stateful docs because everyone was in a rush to meet our big Oct milestone. As we work on improving the Alerting docs, we need to sync them up with serverless, where possible: https://docs.elastic.co/serverless/observability/alerting

@dedemorton
Copy link
Contributor

Closing this issue because the structural changes have been addressed. We still need to provide "content oriented to best practices and use cases our users can relate to" but to accomplish this goal, we need a lot more input from the development team. I'll track that work as part of the meta issue I've created around improving the alerting docs: #3622.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area:ActionableObs classic-docs Team:Docs Label for the Observability docs team
Projects
None yet
Development

No branches or pull requests

5 participants