Merge pull request #75 from simonpasquier/add-observability-ui

Add section about OCP dashboards

.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: |

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.
 

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).

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.

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:

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.

content/Products/OpenshiftMonitoring/telemetry.md

@@ -1,7 +1,3 @@
----
-weight: 30
----
-
 # Sending metrics via Telemetry
 
 ## Targeted audience