Skip to content

Reorganise and add documentation on new stage group dashboards

What does this MR do?

This splits up the documentation that used to live in doc/development/stage_group_dashboards.md into 4 documents:

  • development/stage_group_observability/index.md: This explains how we split our metrics to provide views specific to stage groups and explains error budget: new intro, minor tweaks to the error budget content.
  • development/stage_group_observability/dashboards/index.md: This explains where to find dashboards and some general things on how to use Grafana: mostly moved from the old documentation.
    • development/stage_group_observability/dashboards/stage_group_dashboard.md: This explains how to read and customise the stage group dashboard: mostly moved from the old documentation.
    • development/stage_group_observability/dashboards/error_budget_detail.md: This is new documentation explaining how to read the new dashboard.

Related issues

For gitlab-com/gl-infra/scalability#1587 (closed)

Author's checklist

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Bob Van Landuyt

Merge request reports