From e7161bd352fd4744517578406692cf7f7970b63d Mon Sep 17 00:00:00 2001
From: Simon Pasquier <spasquie@redhat.com>
Date: Wed, 9 Oct 2024 11:07:53 +0200
Subject: [PATCH] Add section about OCP dashboards

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
---
 .mdox.yaml                                            |  6 ++++++
 content/Products/OpenshiftMonitoring/alerting.md      | 10 ++++++----
 .../OpenshiftMonitoring/collecting_metrics.md         |  9 +++++----
 content/Products/OpenshiftMonitoring/dashboards.md    | 11 +++++++++++
 content/Products/OpenshiftMonitoring/faq.md           |  4 ----
 .../Products/OpenshiftMonitoring/instrumentation.md   |  1 +
 content/Products/OpenshiftMonitoring/telemetry.md     |  4 ----
 7 files changed, 29 insertions(+), 16 deletions(-)
 create mode 100644 content/Products/OpenshiftMonitoring/dashboards.md

diff --git a/.mdox.yaml b/.mdox.yaml
index 9626a10..99cd206 100644
--- a/.mdox.yaml
+++ b/.mdox.yaml
@@ -56,6 +56,12 @@ transformations:
         title: "{{ .Origin.FirstHeader }}"
         lastmod: "{{ .Origin.LastMod }}"
         weight: 20
+  - glob: "Products/OpenshiftMonitoring/dashboards.md"
+    frontMatter:
+      template: |
+        title: "{{ .Origin.FirstHeader }}"
+        lastmod: "{{ .Origin.LastMod }}"
+        weight: 25
   - glob: "Products/OpenshiftMonitoring/telemetry.md"
     frontMatter:
       template: |
diff --git a/content/Products/OpenshiftMonitoring/alerting.md b/content/Products/OpenshiftMonitoring/alerting.md
index 9477ebe..9f12973 100644
--- a/content/Products/OpenshiftMonitoring/alerting.md
+++ b/content/Products/OpenshiftMonitoring/alerting.md
@@ -1,8 +1,10 @@
----
-weight: 20
----
+# Alerting
 
-# Alerting guidelines
+## Targeted audience
+
+This document is intended for OpenShift developers that want to write alerting rules for their operators and operands.
+
+## Guidelines
 
 Please refer to the [Alerting Consistency](https://github.com/openshift/enhancements/blob/master/enhancements/monitoring/alerting-consistency.md) OpenShift enhancement proposal for the recommendations applying to OCP built-in alerting rules.
 
diff --git a/content/Products/OpenshiftMonitoring/collecting_metrics.md b/content/Products/OpenshiftMonitoring/collecting_metrics.md
index ec14925..5db9b6b 100644
--- a/content/Products/OpenshiftMonitoring/collecting_metrics.md
+++ b/content/Products/OpenshiftMonitoring/collecting_metrics.md
@@ -1,7 +1,3 @@
----
-weight: 10
----
-
 # Collecting metrics with Prometheus
 
 This document explains how to ingest metrics into the OpenShift Platform monitoring stack. **It only applies for the OCP core components and Red Hat certified operators.**
@@ -250,3 +246,8 @@ spec:
 ## Configuring Prometheus rules
 
 In a similar way, you can configure the Prometheus pods with recording and alerting rules based on the metrics being collected. To do so, you should create `PrometheusRule` objects in your operator/operand namespace which will also be picked up by the Prometheus operator.
+
+## Next steps
+
+* [Configure alerting](alerting.md) with Prometheus.
+* [Send Telemetry metrics](telemetry.md).
diff --git a/content/Products/OpenshiftMonitoring/dashboards.md b/content/Products/OpenshiftMonitoring/dashboards.md
new file mode 100644
index 0000000..69b1ff9
--- /dev/null
+++ b/content/Products/OpenshiftMonitoring/dashboards.md
@@ -0,0 +1,11 @@
+# Dashboards
+
+## Targeted audience
+
+This document is intended for OpenShift developers that want to add visualization dashboards for their operators and operands in the OCP administrator console.
+
+## Getting started
+
+Please refer to the [document](https://docs.google.com/document/d/1UwHwkL-YtrRJYm-A922IeW3wvKEgCR-epeeeh3CBOGs/edit) written by the Observability UI team.
+
+The team can also be found in the `#forum-observability-ui` Slack channel.
diff --git a/content/Products/OpenshiftMonitoring/faq.md b/content/Products/OpenshiftMonitoring/faq.md
index ac1e8a1..f4bae09 100644
--- a/content/Products/OpenshiftMonitoring/faq.md
+++ b/content/Products/OpenshiftMonitoring/faq.md
@@ -1,7 +1,3 @@
----
-weight: 40
----
-
 # Frequently asked questions
 
 This serves as a collection of resources that relate to FAQ around configuring/debugging the in-cluster monitoring stack. Particularly it applies to two OpenShift Projects:
diff --git a/content/Products/OpenshiftMonitoring/instrumentation.md b/content/Products/OpenshiftMonitoring/instrumentation.md
index b8b2aeb..ca744c8 100644
--- a/content/Products/OpenshiftMonitoring/instrumentation.md
+++ b/content/Products/OpenshiftMonitoring/instrumentation.md
@@ -80,3 +80,4 @@ You can find an example of this pattern in the [github.com/prometheus-operator/p
 
 * [Collect metrics](collecting_metrics.md) with Prometheus.
 * [Configure alerting](alerting.md) with Prometheus.
+* [Add dashboards](dashboards.md) to the OCP console.
diff --git a/content/Products/OpenshiftMonitoring/telemetry.md b/content/Products/OpenshiftMonitoring/telemetry.md
index c79f3b4..c66e1c1 100644
--- a/content/Products/OpenshiftMonitoring/telemetry.md
+++ b/content/Products/OpenshiftMonitoring/telemetry.md
@@ -1,7 +1,3 @@
----
-weight: 30
----
-
 # Sending metrics via Telemetry
 
 ## Targeted audience