Incident Management Documentation

TL;DR

We need new documentation for Incident Management in Gitlab docs because current documentation is spread out and confusing to find and follow

Overview

Incident Management as a product category is based on the extension of several other features and this has led to disparate documentation on how someone would use GitLab to manage IT incidents. We need to create a better experience for users by adding a holistic section to the docs titled Incident Management that walks someone through all the features in the experience and how they work together. We can link to other how-to's in the docs, however, we want to minimize context switching for the user who is trying to learn something and make sure the document is complete. As per the handbook guideline, avoid imagery in the docs as much as possible as it quickly becomes out-of-date.

Doc Structure

TITLE: Incident Management

• Overview @seanarnold
• Alerting @seanarnold
  • Prometheus Alerts @seanarnold
  • Alert Endpoint @seanarnold
  • Deduplication * @seanarnold
  • Recovery Alerts * @seanarnold
• Configuring Incidents @seanarnold
  • Auto-creation @seanarnold
  • Issue templates @seanarnold
• Embedded metrics @lauraMon
  • GitLab metrics @lauraMon <- https://docs.gitlab.com/ee/user/project/integrations/prometheus.html#embedding-metric-charts-within-gitlab-flavored-markdown
  • Grafana metrics @lauraMon <- https://docs.gitlab.com/ee/user/project/integrations/prometheus.html#embedding-live-grafana-charts
  • Metrics in issue templates @lauraMon <-!18477 (diffs)
• Slack integration @ohoral
  • Setting it up @ohoral https://docs.gitlab.com/ee/user/project/integrations/slack_slash_commands.html
  • Slash commands @ohoral https://docs.gitlab.com/ee/integration/slash_commands.html
• Zoom in Issues @ohoral - !18467 (merged)

*Indicates that the feature is in-flight but not complete yet

Section Content - everything in italics is guidance on content

• Overview
• Alerting
  • Prometheus Alerts
    • Link to documentation on how to enable Prometheus alerts
  • Alert Endpoint
    • How to enable and authorize the endpoint
  • Deduplication *
    • This feature is currently being built
    • Deduplication of Prometheus alerts
  • Recovery Alerts *
    • This feature is currently being built
    • Close associated issues on receipt of recovery alerts
• Configuring Incidents
  • Auto-creation
  • Issue templates
    • Selecting an issue template to be applied to issues when they automatically create for alerts
    • Using quick actions for auto-assignment and auto-labelling
• Embedded metrics
  • GitLab metrics
    • How to embed metrics
    • Including links to embedded metrics in issues templates
  • Grafana metrics
    • How to embed metrics
    • Including links to embedded metrics in issues templates
• Slack integration
  • Setting it up
    • Link to other documentation
  • Slash commands
    • Link to other documentation
• Zoom in Issues
  • How to associate a zoom call with issue using quick action