Alerting documentation catch-up for GA and other releases

[mikecote]

I'm re-creating an issue similar to (#81532) but providing an overview on our catching up efforts for documentation of GA and other releases.

Phase 1

The first thing I would like to do is to catch-up on the GA documentation. It would be good to divide the work into different areas that won’t make pull requests overlap other people’s work.

As a refresher, there is a writing style guide to help writing docs. We should also remove duplication after writing the asciidoc version.

The work is split between the following issues

• Alerting GA - Connectors documentation Alerting GA - Connectors documentation #89995
• Alerting GA - Alerts documentation Alerting GA - Alerts documentation #89996
• Alerting GA - Task manager documentation Alerting GA - Task manager documentation #89997
• Alerting GA - Event log documentation Alerting GA - Event log documentation #89998
• Alerting GA - General documentation Alerting GA - General documentation #89999

Phase 2

Once we have all the content necessary for GA in the documentation, it would be good to review the documentation’s overall structure and make the appropriate changes. This phase is tracked under #90003.

Phase 3

Once we have figured out our documentation’s overall structure, we should start catching up on the releases’ documentation (7.11 onward). I think it would make sense to have the original PR authors write this documentation to ensure accuracy.

The work is split between the following issues

• Catch-up release documentation - @mikecote Catch-up release documentation - @mikecote #90005
• Catch-up release documentation - @pmuellr Catch-up release documentation - @pmuellr #90006
• Catch-up release documentation - @gmmorris Catch-up release documentation - @gmmorris #90007
• Catch-up release documentation - @YulNaumenko Catch-up release documentation - @YulNaumenko #90008
• Catch-up release documentation - @ymao1 Catch-up release documentation - @ymao1 #90009

Phase 4

Once we’re all caught up, we should develop a process to include the documentation simultaneously as the feature. I think it becomes a requirement for the PR and the reviewers to cover this area as well, and @gchaps can have a review during or after the PR merges.

There is still an open question about examples and user guides. I’m not sure if it would fall in this phase or an earlier one—the same with developer documentation, to facilitate developing alert and action types.

[elasticmachine]

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

[mikecote]

Closing as all sub-issues are complete ✅