Skip to content

Split and clean up Metrics page

Amy Qualls requested to merge docs-aqualls-split-metrics-page into master

What does this MR do?

Begin shifting information around so the front page of the Metrics directory (https://docs.gitlab.com/ee/operations/metrics/) is now an introduction into the default metrics dashboard. Split alerting information out into a new page (operations/metrics/alerts.md) to keep the index page focused. Create new dashboard image to serve as a basic intro to the dashboard setup.

The metrics/dashboards/index.md page (https://docs.gitlab.com/ee/operations/metrics/dashboards/index.html) is still a mess with this MR, but I need this work to land first, and once it lands, turning the Dashboards page into the "custom dashboards" page becomes a LOT easier.

This work will be of intense interest to @nadia_sotnikova, @kbychu, @dhershkovitch, @ClemMakesApps, and @sarahwaldner.

Related issues

Related to #227441 (closed) where the IA was articulated. Related to #229593 (closed) which is a followup to this MR.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Amy Qualls

Merge request reports