From f3fdfe293b91d0aca71ea61212057df600f2da44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9lia=20Barroso?= Date: Tue, 7 Jan 2025 11:48:38 +0000 Subject: [PATCH] [fix] - Docs pipeline --- Documentation/proposals/202411-zone-aware-sharding.md | 10 +++++----- README.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/proposals/202411-zone-aware-sharding.md b/Documentation/proposals/202411-zone-aware-sharding.md index 080a3abcf..5ac34d68b 100644 --- a/Documentation/proposals/202411-zone-aware-sharding.md +++ b/Documentation/proposals/202411-zone-aware-sharding.md @@ -62,7 +62,7 @@ In order to do calculate a stable assignment, following parameters are required: It has to be noted that `zone_label` is supposed to contain a value from the `zones` list. The `num_shards` value is referring to the currently available `.spec.shards` -from the [Prometheus custom resource definition](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Prometheus). +from the [Prometheus custom resource definition](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.Prometheus). Given these values, a target is to be scraped by a given Prometheus instance by using the following algorithm: @@ -162,7 +162,7 @@ for Prometheus in case it is not already allowed to read node objects. > a reconciliation error. Following the algorithm presented above, we suggest the following configuration -options to be added to the [Prometheus](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Prometheus) and PrometheusAgent custom resource definitions. +options to be added to the [Prometheus](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.Prometheus) and PrometheusAgent custom resource definitions. All values used in this snippet should also be the defaults for their corresponding keys. @@ -191,7 +191,7 @@ releases. Both modes do not contain an explicit overwrite of the label used for sharding. This feature is already possible by generating a `__tmp_hash` label through -[scrape classes](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ScrapeClass). +[scrape classes](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.ScrapeClass). In case of the `Topology` mode, two labels are used for sharding. One is used to determine the correct topology of a target, the other one is used to allow @@ -364,8 +364,8 @@ configuration. A field `additionalRelabelConfig` was discussed to allow arbitrary logic to be added before the sharding configuration. It was decided that this would -duplicate the functionality of [scrape classes](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ScrapeClass) -found in, e.g., the [Prometheus](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#prometheusspec) +duplicate the functionality of [scrape classes](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.ScrapeClass) +found in, e.g., the [Prometheus](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#prometheusspec) custom resource definition. The use of `sourceLabel` fields instead of the `__tmp-*` label mechanic was diff --git a/README.md b/README.md index bdddffb88..47a9cf011 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The Prometheus operator includes, but is not limited to, the following features: * **Prometheus Target Configuration**: Automatically generate monitoring target configurations based on familiar Kubernetes label queries; no need to learn a Prometheus specific configuration language. -For an introduction to the Prometheus Operator, see the [getting started](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md) guide. +For an introduction to the Prometheus Operator, see the [getting started](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/developer/getting-started.md) guide. ## Project Status