Skip to content

Commit 99df1c4

Browse files
authored
Merge pull request #94837 from eromanova97/OBSDOCS-1912
OBSDOCS-1912: Review the format for external links in monitoring docs
2 parents 01609d5 + e21fc3b commit 99df1c4

12 files changed

+38
-38
lines changed

observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ include::modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-
2424
[role="_additional-resources"]
2525
.Additional resources
2626

27-
* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus] (Prometheus documentation)
27+
* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus (Prometheus documentation)]
2828
2929
//Reviewing monitoring dashboards as a developer
3030
include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[leveloffset=+1]

observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ include::modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard
2424
[role="_additional-resources"]
2525
.Additional resources
2626

27-
* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus] (Prometheus documentation)
27+
* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus (Prometheus documentation)]
2828
2929
//Getting detailed information about a metrics target
3030
include::modules/monitoring-getting-detailed-information-about-a-target.adoc[leveloffset=+1]

observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::modules/monitoring-disabling-the-local-alertmanager.adoc[leveloffset=+2
1717
[role="_additional-resources"]
1818
.Additional resources
1919

20-
* link:https://prometheus.io/docs/alerting/latest/alertmanager/[Alertmanager] (Prometheus documentation)
20+
* link:https://prometheus.io/docs/alerting/latest/alertmanager/[Alertmanager (Prometheus documentation)]
2121
* xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator]
2222
2323
//Configuring secrets for Alertmanager
@@ -47,8 +47,8 @@ Alertmanager does not send notifications by default. It is strongly recommended
4747
.Additional resources
4848

4949
* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
50-
* link:https://www.pagerduty.com/[PagerDuty] (PagerDuty official site)
51-
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide] (PagerDuty official site)
50+
* link:https://www.pagerduty.com/[PagerDuty website]
51+
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
5252
* xref:../../../observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
5353
* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
5454

@@ -57,13 +57,13 @@ include::modules/monitoring-configuring-alert-routing-default-platform-alerts.ad
5757
[role="_additional-resources"]
5858
.Additional resources
5959

60-
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4] (Red{nbsp}Hat Customer Portal)
60+
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4 (Red{nbsp}Hat Customer Portal)]
6161

6262
include::modules/monitoring-configuring-alert-routing-console.adoc[leveloffset=+2]
6363

6464
[role="_additional-resources"]
6565
.Additional resources
6666

67-
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4] (Red{nbsp}Hat Customer Portal)
67+
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4 (Red{nbsp}Hat Customer Portal)]
6868

6969
include::modules/monitoring-configuring-different-alert-receivers-for-default-platform-alerts-and-user-defined-alerts.adoc[leveloffset=+2]

observability/monitoring/configuring-core-platform-monitoring/configuring-metrics.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1
2222
.Additional resources
2323

2424
* xref:../../../rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#spec-remotewrite-writerelabelconfigs[`writeRelabelConfigs`]
25-
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[`relabel_config`] (Prometheus documentation)
25+
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[`relabel_config` (Prometheus documentation)]
2626
2727
include::modules/monitoring-supported-remote-write-authentication-settings.adoc[leveloffset=+2]
2828

@@ -34,8 +34,8 @@ include::modules/monitoring-example-remote-write-queue-configuration.adoc[levelo
3434
.Additional resources
3535

3636
* xref:../../../rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#spec-remotewrite-2[Prometheus REST API reference for remote write]
37-
* link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Setting up remote write compatible endpoints] (Prometheus documentation)
38-
* link:https://prometheus.io/docs/practices/remote_write/#remote-write-tuning[Tuning remote write settings] (Prometheus documentation)
37+
* link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Remote write compatible endpoints (Prometheus documentation)]
38+
* link:https://prometheus.io/docs/practices/remote_write/#remote-write-tuning[Remote write tuning (Prometheus documentation)]
3939
* xref:../../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets]
4040
4141
//Creating cluster ID labels for metrics for core platform monitoring

observability/monitoring/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ include::modules/monitoring-moving-monitoring-components-to-different-nodes.adoc
3535
* xref:../../../observability/monitoring/configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[Preparing to configure core platform monitoring stack]
3636
* xref:../../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes]
3737
* xref:../../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
38-
* link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[nodeSelector] (Kubernetes documentation)
38+
* link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[`nodeSelector` (Kubernetes documentation)]
3939

4040
include::modules/monitoring-assigning-tolerations-to-monitoring-components.adoc[leveloffset=+2,tags=**;CPM;!UWM]
4141

@@ -44,15 +44,15 @@ include::modules/monitoring-assigning-tolerations-to-monitoring-components.adoc[
4444

4545
* xref:../../../observability/monitoring/configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[Preparing to configure core platform monitoring stack]
4646
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
47-
* link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Taints and Tolerations] (Kubernetes documentation)
47+
* link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Taints and tolerations (Kubernetes documentation)]
4848

4949
// Setting the body size limit for metrics scraping
5050
include::modules/monitoring-setting-the-body-size-limit-for-metrics-scraping.adoc[leveloffset=+1]
5151

5252
[role="_additional-resources"]
5353
.Additional resources
5454

55-
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config[scrape_config configuration] (Prometheus documentation)
55+
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config[`scrape_config` (Prometheus documentation)]
5656

5757
[id="managing-cpu-and-memory-resources-for-monitoring-components_{context}"]
5858
== Managing CPU and memory resources for monitoring components
@@ -67,7 +67,7 @@ include::modules/monitoring-specifying-limits-and-requests-for-monitoring-compon
6767
.Additional resources
6868

6969
* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-specifying-limits-and-requests-for-monitoring-components_key-concepts[About specifying limits and requests]
70-
* link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits[Kubernetes requests and limits documentation] (Kubernetes documentation)
70+
* link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits[Requests and limits (Kubernetes documentation)]
7171

7272
// Choosing a metrics collection profile
7373
include::modules/monitoring-choosing-a-metrics-collection-profile.adoc[leveloffset=+1]
@@ -87,7 +87,7 @@ include::modules/monitoring-configuring-pod-topology-spread-constraints.adoc[lev
8787

8888
* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#using-pod-topology-spread-constraints-for-monitoring_key-concepts[About pod topology spread constraints for monitoring]
8989
* xref:../../../nodes/scheduling/nodes-scheduler-pod-topology-spread-constraints.adoc#nodes-scheduler-pod-topology-spread-constraints-about[Controlling pod placement by using pod topology spread constraints]
90-
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/[Pod Topology Spread Constraints] (Kubernetes documentation)
90+
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/[Pod topology spread constraints (Kubernetes documentation)]
9191

9292

9393

observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::modules/monitoring-configuring-a-persistent-volume-claim.adoc[leveloffs
1717
.Additional resources
1818

1919
* xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage]
20-
* link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[PersistentVolumeClaims] (Kubernetes documentation)
20+
* link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[PersistentVolumeClaims (Kubernetes documentation)]
2121
2222
include::modules/monitoring-resizing-a-persistent-volume.adoc[leveloffset=+2,tags=**;CPM;!UWM]
2323

observability/monitoring/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ Review the following limitations of alert routing for user-defined projects:
5656

5757
* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#understanding-alert-routing-for-user-defined-projects_key-concepts[Understanding alert routing for user-defined projects]
5858
* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
59-
* link:https://www.pagerduty.com/[PagerDuty] (PagerDuty official site)
60-
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide] (PagerDuty official site)
59+
* link:https://www.pagerduty.com/[PagerDuty website]
60+
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
6161
* xref:../../../observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
6262
* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
6363
@@ -66,13 +66,13 @@ include::modules/monitoring-configuring-alert-routing-for-user-defined-projects.
6666
[role="_additional-resources"]
6767
.Additional resources
6868

69-
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4] (Red{nbsp}Hat Customer Portal)
69+
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4 (Red{nbsp}Hat Customer Portal)]
7070
7171
include::modules/monitoring-configuring-alert-routing-user-defined-alerts-secret.adoc[leveloffset=+2]
7272

7373
[role="_additional-resources"]
7474
.Additional resources
7575

76-
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4] (Red{nbsp}Hat Customer Portal)
76+
* link:https://access.redhat.com/solutions/6828481[Send test alerts to Alertmanager in OpenShift 4 (Red{nbsp}Hat Customer Portal)]
7777
7878
include::modules/monitoring-configuring-different-alert-receivers-for-default-platform-alerts-and-user-defined-alerts.adoc[leveloffset=+2]

observability/monitoring/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1
2323
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2424
* xref:../../../rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#spec-remotewrite-writerelabelconfigs[`writeRelabelConfigs`]
2525
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
26-
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[`relabel_config`] (Prometheus documentation)
26+
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[`relabel_config` (Prometheus documentation)]
2727

2828
include::modules/monitoring-supported-remote-write-authentication-settings.adoc[leveloffset=+2]
2929

@@ -36,8 +36,8 @@ include::modules/monitoring-example-remote-write-queue-configuration.adoc[levelo
3636
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3737
* xref:../../../rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#spec-remotewrite-2[Prometheus REST API reference for remote write]
3838
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
39-
* link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Setting up remote write compatible endpoints] (Prometheus documentation)
40-
* link:https://prometheus.io/docs/practices/remote_write/#remote-write-tuning[Tuning remote write settings] (Prometheus documentation)
39+
* link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Remote write compatible endpoints (Prometheus documentation)]
40+
* link:https://prometheus.io/docs/practices/remote_write/#remote-write-tuning[Remote write tuning (Prometheus documentation)]
4141
* xref:../../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets]
4242

4343
// Creating cluster ID labels for metrics for monitoring of user-defined projects
@@ -67,5 +67,5 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
6767
* xref:../../../rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[PodMonitor API]
6868
* xref:../../../rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor API]
6969
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
70-
* link:https://access.redhat.com/articles/6675491[Scrape Prometheus metrics using TLS in ServiceMonitor configuration] (Red{nbsp}Hat Customer Portal article)
70+
* link:https://access.redhat.com/articles/6675491[Scrape Prometheus metrics using TLS in ServiceMonitor configuration (Red{nbsp}Hat Customer Portal)]
7171

observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3535
* xref:../../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes]
3636
* xref:../../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
3737
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
38-
* link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[nodeSelector] (Kubernetes documentation)
38+
* link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[`nodeSelector` (Kubernetes documentation)]
3939

4040
include::modules/monitoring-assigning-tolerations-to-monitoring-components.adoc[leveloffset=+2,tags=**;!CPM;UWM]
4141

@@ -46,7 +46,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4646
* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
4747
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
4848
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
49-
* link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Taints and Tolerations] (Kubernetes documentation)
49+
* link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Taints and tolerations (Kubernetes documentation)]
5050

5151
[id="managing-cpu-and-memory-resources-for-monitoring-components_{context}"]
5252
== Managing CPU and memory resources for monitoring components
@@ -60,7 +60,7 @@ include::modules/monitoring-specifying-limits-and-requests-for-monitoring-compon
6060
[role="_additional-resources"]
6161
.Additional resources
6262
* xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-specifying-limits-and-requests-for-monitoring-components_key-concepts[About specifying limits and requests for monitoring components]
63-
* link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits[Kubernetes requests and limits documentation] (Kubernetes documentation)
63+
* link:https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits[Requests and limits (Kubernetes documentation)]
6464

6565
[id="controlling-the-impact-of-unbound-attributes-in-user-defined-projects_{context}"]
6666
== Controlling the impact of unbound metrics attributes in user-defined projects
@@ -110,4 +110,4 @@ include::modules/monitoring-configuring-pod-topology-spread-constraints.adoc[lev
110110
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
111111
* xref:../../../nodes/scheduling/nodes-scheduler-pod-topology-spread-constraints.adoc#nodes-scheduler-pod-topology-spread-constraints-about[Controlling pod placement by using pod topology spread constraints]
112112
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
113-
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/[Pod Topology Spread Constraints] (Kubernetes documentation)
113+
* link:https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/[Pod topology spread constraints (Kubernetes documentation)]

observability/monitoring/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::modules/monitoring-configuring-a-persistent-volume-claim.adoc[leveloffs
1717
.Additional resources
1818

1919
* xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage]
20-
* link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[PersistentVolumeClaims] (Kubernetes documentation)
20+
* link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[PersistentVolumeClaims (Kubernetes documentation)]
2121
2222
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2323
include::modules/monitoring-resizing-a-persistent-volume.adoc[leveloffset=+2,tags=**;!CPM;UWM]

0 commit comments

Comments
 (0)