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

Jump to bottom

Documentation template for alert and action types #82000

Closed
mikecote opened this issue Oct 29, 2020 · 4 comments · Fixed by #92830
Closed

Documentation template for alert and action types #82000

mikecote opened this issue Oct 29, 2020 · 4 comments · Fixed by #92830
Labels
Feature:Actions Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@mikecote
Copy link
Contributor

Created from #75548 (comment).

Currently there is no guideline on how to document an alert type (or action type) and we have documentation for some that is only a single paragraph while others having a dedicated page with examples.

It would be nice to work with the docs team (cc @gchaps) and to come up with a documentation template for alert and action types to follow.
@mikecote mikecote added Feature:Alerting Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Oct 29, 2020
@elasticmachine
Copy link
Contributor

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

@mikecote mikecote mentioned this issue Oct 29, 2020
Closed
@mikecote mikecote added this to 7.12 - Tentative in Make it Action Nov 3, 2020
@mikecote
Copy link
Contributor Author

cc @arisonl

@mikecote
Copy link
Contributor Author

Moving from 7.12 - Candidates to 7.x - Candidates.

@mikecote mikecote moved this from 7.12 - Candidates to 7.x - Candidates in Make it Action Dec 30, 2020
@mikecote mikecote removed this from 7.x - Candidates in Make it Action Jan 27, 2021
@mikecote mikecote added this to 7.x - Candidates in Kibana Alerting Jan 27, 2021
@mikecote mikecote mentioned this issue Feb 5, 2021
Closed
5 tasks
@mikecote
Copy link
Contributor Author

mikecote commented Feb 5, 2021

Removing from the project, now part of #89999 meta issue in To-Do.

@mikecote mikecote removed this from 7.x - Candidates in Kibana Alerting Feb 5, 2021
@ymao1 ymao1 mentioned this issue Feb 25, 2021
Merged
1 task
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature:Actions Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Alerting][Docs] Adding template for documenting alert and action types ymao1/kibana
3 participants
@kobelb @mikecote @elasticmachine