Merge pull request #93526 from max-cx/OBSDOCS-1629fix

michaelryanpeter · web-flow · commit 9d716cee87a8 · 2025-05-29T16:41:07.000-04:00
OBSDOCS-1629: Fix
diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc
@@ -129,19 +129,19 @@ endif::[]
 :ove-first: Red{nbsp}Hat OpenShift Virtualization Engine
 :ove: OpenShift Virtualization Engine
 //distributed tracing
-:DTProductName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
+:DTProductName: Red Hat OpenShift Distributed Tracing Platform
 :DTShortName: Distributed Tracing Platform
 :DTProductVersion: 3.1
-:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
-:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
+:JaegerName: Red Hat OpenShift Distributed Tracing Platform (Jaeger)
+:JaegerOperator: Red Hat OpenShift Distributed Tracing Platform
 :JaegerShortName: Distributed Tracing Platform (Jaeger)
-:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
+:JaegerOperator: Red Hat OpenShift Distributed Tracing Platform
 :JaegerVersion: 1.53.0
 :OTELName: Red{nbsp}Hat build of OpenTelemetry
 :OTELShortName: Red{nbsp}Hat build of OpenTelemetry
 :OTELOperator: Red{nbsp}Hat build of OpenTelemetry Operator
 :OTELVersion: 0.93.0
-:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
+:TempoName: Red Hat OpenShift Distributed Tracing Platform
 :TempoShortName: Distributed Tracing Platform
 :TempoOperator: Tempo Operator
 :TempoVersion: 2.3.1
diff --git a/modules/distr-tracing-removing-instance-cli.adoc b/modules/distr-tracing-removing-instance-cli.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_jaeger/dist-tracing-removing.adoc
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-removing.adoc
 
 [id="distr-tracing-removing-instance-cli_{context}"]
 = Removing a {JaegerShortName} instance by using the CLI
diff --git a/modules/distr-tracing-removing-instance.adoc b/modules/distr-tracing-removing-instance.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_jaeger/dist-tracing-removing.adoc
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-removing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-removing-instance_{context}"]
diff --git a/modules/distr-tracing-sidecar-automatic.adoc b/modules/distr-tracing-sidecar-automatic.adoc
@@ -3,7 +3,7 @@
 // * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
 
 :_mod-docs-content-type: REFERENCE
-[id="dist-tracing-sidecar-automatic_{context}"]
+[id="distr-tracing-sidecar-automatic_{context}"]
 = Automatically injecting sidecars
 
 The {JaegerName} Operator can inject Jaeger Agent sidecars into deployment workloads. To enable automatic injection of sidecars, add the `sidecar.jaegertracing.io/inject` annotation set to either the string `true` or to the {JaegerShortName} instance name that is returned by running `$ oc get jaegers`.
diff --git a/modules/distr-tracing-tempo-remove-cli.adoc b/modules/distr-tracing-tempo-remove-cli.adoc
@@ -1,6 +1,6 @@
 //Module included in the following assemblies:
 //
-//* observability/distr_tracing/dist-tracing-tempo-removing.adoc
+//* observability/distr_tracing/distr-tracing-tempo-removing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-removing-tempo-instance-cli_{context}"]
diff --git a/modules/distr-tracing-tempo-remove-web-console.adoc b/modules/distr-tracing-tempo-remove-web-console.adoc
@@ -1,6 +1,6 @@
 //Module included in the following assemblies:
 //
-//* observability/distr_tracing/dist-tracing-tempo-removing.adoc
+//* observability/distr_tracing/distr-tracing-tempo-removing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-removing-tempo-instance_{context}"]
diff --git a/observability/distr_tracing/distr-tracing-architecture.adoc b/observability/distr_tracing/distr-tracing-architecture.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-architecture"]
 = About the {DTShortName}
-include::_attributes/common-attributes.adoc[]
 :context: distributed-tracing-architecture
 
 toc::[]
@@ -28,4 +28,4 @@ include::modules/distr-tracing-architecture.adoc[leveloffset=+1]
 == Additional resources
 
 // xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files
-* xref:../otel/otel-installing.adoc#install-otel[{OTELName}]
+* xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}]
diff --git a/observability/distr_tracing/distr-tracing-rn.adoc b/observability/distr_tracing/distr-tracing-rn.adoc
@@ -299,7 +299,7 @@ endif::openshift-rosa[]
 [id="distr-tracing_3-3-1_{context}"]
 == Release notes for {DTProductName} 3.3.1
 
-The {DTProductName} 3.3.1 is a maintenance release with no changes because the {DTProductName} is bundled with the {OTELName} that is xref:../otel/otel-rn.adoc#otel_rn[released] with a bug fix.
+The {DTProductName} 3.3.1 is a maintenance release with no changes because the {DTProductName} is bundled with the {OTELName} that is xref:../../observability/otel/otel-rn.adoc#otel_rn[released] with a bug fix.
 
 This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
 
@@ -393,7 +393,7 @@ The {JaegerName} 3.3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
 In the {DTProductName} 3.3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
 Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
 
-The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage.
+The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage.
 
 ////
 [id="distr-tracing_3-3-1_jaeger-release-notes_removal-notice_{context}"]
@@ -522,7 +522,7 @@ The {JaegerName} 3.3 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
 In the {DTProductName} 3.3, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
 Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
 
-The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage.
+The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage.
 
 ////
 [id="distr-tracing_3-3_jaeger-release-notes_removal-notice_{context}"]
diff --git a/observability/distr_tracing/distr-tracing-tempo-configuring.adoc b/observability/distr_tracing/distr-tracing-tempo-configuring.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-tempo-configuring"]
 = Configuring the {DTShortName}
-include::_attributes/common-attributes.adoc[]
 :context: distr-tracing-tempo-configuring
 
 toc::[]
diff --git a/observability/distr_tracing/distr-tracing-tempo-installing.adoc b/observability/distr_tracing/distr-tracing-tempo-installing.adoc
@@ -1,14 +1,14 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-tempo-installing"]
 = Installing the {DTShortName}
-include::_attributes/common-attributes.adoc[]
 :context: distr-tracing-tempo-installing
 
 toc::[]
 
 [TIP]
 ====
-For information about installing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc#dist-tracing-jaeger-installing[Installing] in the {JaegerShortName} documentation.
+For information about installing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc#distr-tracing-jaeger-installing[Installing] in the {JaegerShortName} documentation.
 ====
 
 Installing the {TempoShortName} involves the following steps:
diff --git a/observability/distr_tracing/distr-tracing-tempo-removing.adoc b/observability/distr_tracing/distr-tracing-tempo-removing.adoc
@@ -1,14 +1,14 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-tempo-removing"]
 = Removing the {DTShortName}
-include::_attributes/common-attributes.adoc[]
 :context: distr-tracing-tempo-removing
 
 toc::[]
 
 [TIP]
 ====
-For information about removing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc#dist-tracing-jaeger-removing[Removing] in the {JaegerShortName} documentation.
+For information about removing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc#distr-tracing-jaeger-removing[Removing] in the {JaegerShortName} documentation.
 ====
 
 The steps for removing the {TempoName} from an {product-title} cluster are as follows:
diff --git a/observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc b/observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-tempo-troubleshooting"]
 = Troubleshooting the {DTShortName}
-include::_attributes/common-attributes.adoc[]
 :context: distr-tracing-tempo-troubleshooting
 
 toc::[]
diff --git a/observability/distr_tracing/distr-tracing-tempo-updating.adoc b/observability/distr_tracing/distr-tracing-tempo-updating.adoc
@@ -1,14 +1,14 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-tempo-updating"]
 = Upgrading
-include::_attributes/common-attributes.adoc[]
 :context: distr-tracing-tempo-updating
 
 toc::[]
 
 [TIP]
 ====
-For information about upgrading the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc#dist-tracing-jaeger-updating[Upgrading] in the {JaegerShortName} documentation.
+For information about upgrading the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc#distr-tracing-jaeger-updating[Upgrading] in the {JaegerShortName} documentation.
 ====
 
 For version upgrades, the {TempoOperator} uses the Operator Lifecycle Manager (OLM), which controls installation, upgrade, and role-based access control (RBAC) of Operators in a cluster.
diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
@@ -1,8 +1,8 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="dist-tracing-jaeger-installing"]
+[id="distr-tracing-jaeger-installing"]
 = Installing the {JaegerShortName}
 include::_attributes/common-attributes.adoc[]
-:context: dist-tracing-jaeger-installing
+:context: distr-tracing-jaeger-installing
 
 toc::[]
 
diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc
@@ -1,8 +1,8 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="dist-tracing-jaeger-removing"]
+[id="distr-tracing-jaeger-removing"]
 = Removing the {JaegerShortName}
 include::_attributes/common-attributes.adoc[]
-:context: dist-tracing-jaeger-removing
+:context: distr-tracing-jaeger-removing
 
 toc::[]
 
diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc
@@ -1,8 +1,8 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="dist-tracing-jaeger-updating"]
+[id="distr-tracing-jaeger-updating"]
 = Upgrading the {JaegerShortName}
 include::_attributes/common-attributes.adoc[]
-:context: dist-tracing-jaeger-updating
+:context: distr-tracing-jaeger-updating
 
 toc::[]
 
diff --git a/observability/otel/otel-collector/otel-collector-configuration-intro.adoc b/observability/otel/otel-collector/otel-collector-configuration-intro.adoc
@@ -9,4 +9,5 @@ toc::[]
 The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELShortName} resources. You can install the default configuration or modify the file.
 
 include::modules/otel-collector-config-options.adoc[leveloffset=+1]
+
 include::modules/otel-creating-required-RBAC-resources-automatically.adoc[leveloffset=+1]
diff --git a/observability/otel/otel-config-multicluster.adoc b/observability/otel/otel-config-multicluster.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-gathering-observability-data-from-multiple-clusters"]
 = Gathering the observability data from multiple clusters
-include::_attributes/common-attributes.adoc[]
 :context: otel-gathering-observability-data-from-multiple-clusters
 
 For a multicluster configuration, you can create one OpenTelemetry Collector instance in each one of the remote clusters and then forward all the telemetry data to one OpenTelemetry Collector instance.
diff --git a/observability/otel/otel-configuration-of-instrumentation.adoc b/observability/otel/otel-configuration-of-instrumentation.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-configuration-of-instrumentation"]
 = Configuring the instrumentation
-include::_attributes/common-attributes.adoc[]
 :context: otel-configuration-of-instrumentation
 
 toc::[]
@@ -10,4 +10,5 @@ toc::[]
 The {OTELName} Operator uses an `Instrumentation` custom resource that defines the configuration of the instrumentation.
 
 include::modules/otel-autoinstrumentation.adoc[leveloffset=+1]
+
 include::modules/otel-config-instrumentation.adoc[leveloffset=+1]
diff --git a/observability/otel/otel-configuring-metrics-for-monitoring-stack.adoc b/observability/otel/otel-configuring-metrics-for-monitoring-stack.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-configuring-metrics-for-monitoring-stack"]
 = Configuring metrics for the monitoring stack
-include::_attributes/common-attributes.adoc[]
 :context: otel-configuring-metrics-for-monitoring-stack
 
 toc::[]
@@ -13,6 +13,7 @@ As a cluster administrator, you can configure the OpenTelemetry Collector custom
 * Configure the Prometheus receiver to scrape metrics from the in-cluster monitoring stack.
 
 include::modules/otel-config-send-metrics-monitoring-stack.adoc[leveloffset=+1]
+
 include::modules/otel-config-receive-metrics-monitoring-stack.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
diff --git a/observability/otel/otel-configuring-otelcol-metrics.adoc b/observability/otel/otel-configuring-otelcol-metrics.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-configuring-metrics"]
 = Configuring the OpenTelemetry Collector metrics
-include::_attributes/common-attributes.adoc[]
 :context: otel-configuring-metrics
 
 The following list shows some of these metrics:
diff --git a/observability/otel/otel-forwarding-telemetry-data.adoc b/observability/otel/otel-forwarding-telemetry-data.adoc
@@ -1,14 +1,15 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-forwarding-telemetry-data"]
 = Forwarding telemetry data
-include::_attributes/common-attributes.adoc[]
 :context: otel-forwarding-telemetry-data
 
 toc::[]
 
 You can use the OpenTelemetry Collector to forward your telemetry data.
 
 include::modules/otel-forwarding-traces.adoc[leveloffset=+1]
+
 include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1]
 
 ////
diff --git a/observability/otel/otel-installing.adoc b/observability/otel/otel-installing.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="install-otel"]
 = Installing
-include::_attributes/common-attributes.adoc[]
 :context: install-otel
 
 toc::[]
diff --git a/observability/otel/otel-migrating.adoc b/observability/otel/otel-migrating.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-migrating"]
 = Migrating
-include::_attributes/common-attributes.adoc[]
 :context: otel-migrating
 
 toc::[]
diff --git a/observability/otel/otel-removing.adoc b/observability/otel/otel-removing.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-removing"]
 = Removing
-include::_attributes/common-attributes.adoc[]
 :context: otel-removing
 
 toc::[]
diff --git a/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc b/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-sending-traces-and-metrics-to-otel-collector"]
 = Sending traces and metrics to the OpenTelemetry Collector
-include::_attributes/common-attributes.adoc[]
 :context: otel-sending-traces-and-metrics-to-otel-collector
 
 toc::[]
diff --git a/observability/otel/otel-troubleshooting.adoc b/observability/otel/otel-troubleshooting.adoc
@@ -1,17 +1,21 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-troubleshoot"]
 = Troubleshooting
-include::_attributes/common-attributes.adoc[]
 :context: otel-troubleshoot
 
 toc::[]
 
 The OpenTelemetry Collector offers multiple ways to measure its health as well as investigate data ingestion issues.
 
 include::modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc[leveloffset=+1]
+
 include::modules/otel-troubleshoot-collector-logs.adoc[leveloffset=+1]
+
 include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1]
+
 include::modules/otel-troubleshoot-debug-exporter-stdout.adoc[leveloffset=+1]
+
 include::modules/otel-troubleshoot-network-traffic.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
@@ -30,4 +34,5 @@ To troubleshoot the instrumentation, look for any of the following issues:
 * Issues with data generation by the instrumentation libraries
 
 include::modules/otel-troubleshooting-instrumentation-injection-into-your-workload.adoc[leveloffset=+2]
+
 include::modules/otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries.adoc[leveloffset=+2]
diff --git a/observability/otel/otel-updating.adoc b/observability/otel/otel-updating.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
 [id="otel-updating"]
 = Upgrading
-include::_attributes/common-attributes.adoc[]
 :context: otel-updating
 
 toc::[]
