Create docs/observability folder with metrics.md

Signed-off-by: João Vilaça <[email protected]>

docs/monitoring-guidelines.md

@@ -43,4 +43,4 @@ When creating a KubeVirt alert rule, please see the following :
      - Warning alerts - When an alert require user intervention. A more serious issue may develop if this is not resolved soon.
      - Info alerts - When a minor problem has been detected. It should be resolved relatively soon and not ignored.
 
-5. Alert `message` must be verbose, since it is being propagated to the [metrics.md](https://github.com/kubevirt/kubevirt/blob/main/docs/metrics.md) file, when running `make-generate`.
+5. Alert `message` must be verbose, since it is being propagated to the [observability/metrics.md](https://github.com/kubevirt/kubevirt/blob/main/docs/observability/metrics.md) file, when running `make-generate`.

docs/observability/OWNERS

@@ -0,0 +1,8 @@
+# See the OWNERS docs at https://go.k8s.io/owners
+
+approvers:
+  - sig-observability-approvers
+reviewers:
+  - sig-observability-reviewers
+labels:
+  - sig/observability

hack/generate.sh

@@ -178,7 +178,7 @@ ${KUBEVIRT_DIR}/tools/openapispec/openapispec --dump-api-spec-path ${KUBEVIRT_DI
 (cd ${KUBEVIRT_DIR}/tools/csv-generator/ && go_build)
 (cd ${KUBEVIRT_DIR}/tools/doc-generator/ && go_build)
 (
-    cd ${KUBEVIRT_DIR}/docs
+    cd ${KUBEVIRT_DIR}/docs/observability
     ${KUBEVIRT_DIR}/tools/doc-generator/doc-generator >metrics.md
 )
 

hack/prom-metric-linter/metrics_collector.sh

@@ -21,7 +21,7 @@
 set -e
 
 PROJECT_ROOT="$(readlink -e "$(dirname "${BASH_SOURCE[0]}")"/../../)"
-export METRICS_DOC_PATH="${METRICS_DOC_PATH:-${PROJECT_ROOT}/docs/metrics.md}"
+export METRICS_DOC_PATH="${METRICS_DOC_PATH:-${PROJECT_ROOT}/docs/observability/metrics.md}"
 export METRICS_COLLECTOR_PATH="${METRICS_COLLECTOR_PATH:-${PROJECT_ROOT}/tools/prom-metrics-collector}"
 
 if [[ ! -f "$METRICS_DOC_PATH" ]]; then