Merge pull request #93471 from max-cx/enterprise-4.17

[enterprise-4.17] OBSDOCS-1629: Flatten the Distributed tracing docs structure

Author: stevsmit

_attributes/common-attributes.adoc

@@ -122,20 +122,20 @@ endif::[]
 :ove-first: Red Hat OpenShift Virtualization Engine
 :ove: OpenShift Virtualization Engine
 //distributed tracing
-:DTProductName: Red Hat OpenShift distributed tracing platform
-:DTShortName: distributed tracing platform
+:DTProductName: Red Hat OpenShift Distributed Tracing Platform
+:DTShortName: Distributed Tracing Platform
 :DTProductVersion: 3.1
-:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
-:JaegerOperator: Red Hat OpenShift distributed tracing platform
-:JaegerShortName: distributed tracing platform (Jaeger)
-:JaegerOperator: Red 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 Hat OpenShift Distributed Tracing Platform
 :JaegerVersion: 1.53.0
 :OTELName: Red Hat build of OpenTelemetry
 :OTELShortName: Red Hat build of OpenTelemetry
 :OTELOperator: Red Hat build of OpenTelemetry Operator
 :OTELVersion: 0.93.0
-:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
-:TempoShortName: distributed tracing platform (Tempo)
+:TempoName: Red Hat OpenShift Distributed Tracing Platform
+:TempoShortName: Distributed Tracing Platform
 :TempoOperator: Tempo Operator
 :TempoVersion: 2.3.1
 //telco

_topic_maps/_topic_map.yml

@@ -3180,48 +3180,42 @@ Topics:
 #      File: logging-5-6-reference
 #  - Name: Glossary
 #    File: logging-common-terms
-- Name: Distributed tracing
+- Name: Distributed Tracing
   Dir: distr_tracing
   Distros: openshift-enterprise
   Topics:
-  - Name: Release notes
+  - Name: Release notes for the Distributed Tracing Platform
     File: distr-tracing-rn
-  - Name: Distributed tracing architecture
-    Dir: distr_tracing_arch
-    Topics:
-    - Name: Distributed tracing architecture
-      File: distr-tracing-architecture
-  - Name: Distributed tracing platform (Tempo)
-    Dir: distr_tracing_tempo
-    Topics:
-    - Name: Installing
-      File: distr-tracing-tempo-installing
-    - Name: Configuring
-      File: distr-tracing-tempo-configuring
-    - Name: Troubleshooting
-      File: distr-tracing-tempo-troubleshooting
-    - Name: Upgrading
-      File: distr-tracing-tempo-updating
-    - Name: Removing
-      File: distr-tracing-tempo-removing
-  - Name: Distributed tracing platform (Jaeger)
+  - Name: About the Distributed Tracing Platform
+    File: distr-tracing-architecture
+  - Name: Installing the Distributed Tracing Platform
+    File: distr-tracing-tempo-installing
+  - Name: Configuring the Distributed Tracing Platform
+    File: distr-tracing-tempo-configuring
+  - Name: Troubleshooting the Distributed Tracing Platform
+    File: distr-tracing-tempo-troubleshooting
+  - Name: Upgrading the Distributed Tracing Platform
+    File: distr-tracing-tempo-updating
+  - Name: Removing the Distributed Tracing Platform
+    File: distr-tracing-tempo-removing
+  - Name: Distributed Tracing Platform (Jaeger)
     Dir: distr_tracing_jaeger
     Topics:
-    - Name: Installing
+    - Name: Installing the Distributed Tracing Platform (Jaeger)
       File: distr-tracing-jaeger-installing
-    - Name: Configuring
+    - Name: Configuring the Distributed Tracing Platform (Jaeger)
       File: distr-tracing-jaeger-configuring
-    - Name: Upgrading
+    - Name: Upgrading the Distributed Tracing Platform (Jaeger)
       File: distr-tracing-jaeger-updating
-    - Name: Removing
+    - Name: Removing the Distributed Tracing Platform (Jaeger)
       File: distr-tracing-jaeger-removing
 - Name: Red Hat build of OpenTelemetry
   Dir: otel
   Distros: openshift-enterprise
   Topics:
-  - Name: Release notes
+  - Name: Release notes for the Red Hat build of OpenTelemetry
     File: otel-rn
-  - Name: Installing
+  - Name: Installing the Red Hat build of OpenTelemetry
     File: otel-installing
   - Name: Configuring the Collector
     Dir: otel-collector
@@ -3252,13 +3246,13 @@ Topics:
     File: otel-configuring-otelcol-metrics
   - Name: Gathering the observability data from multiple clusters
     File: otel-config-multicluster
-  - Name: Troubleshooting
+  - Name: Troubleshooting the Red Hat build of OpenTelemetry
     File: otel-troubleshooting
-  - Name: Migrating
+  - Name: Migrating to the Red Hat build of OpenTelemetry
     File: otel-migrating
-  - Name: Upgrading
+  - Name: Upgrading the Red Hat build of OpenTelemetry
     File: otel-updating
-  - Name: Removing
+  - Name: Removing the Red Hat build of OpenTelemetry
     File: otel-removing
 - Name: Network Observability
   Dir: network_observability

modules/distr-tracing-architecture.adoc

@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * service_mesh/v2x/ossm-architecture.adoc
-// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
+// * observability/distr_tracing/distr-tracing-architecture.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="distr-tracing-architecture_{context}"]
@@ -27,6 +27,8 @@
 
 ** *OpenTelemetry Collector* - The OpenTelemetry Collector is a vendor-agnostic way to receive, process, and export telemetry data. The OpenTelemetry Collector supports open-source observability data formats, for example, Jaeger and Prometheus, sending to one or more open-source or commercial back-ends. The Collector is the default location instrumentation libraries export their telemetry data.
 
+// when removing the Jaeger docs, remove all the following lines to the end of the file
+
 * *{JaegerName}* - This component is based on the open source link:https://www.jaegertracing.io/[Jaeger project].
 +
 :FeatureName: The {JaegerName}

modules/distr-tracing-features.adoc

@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * service_mesh/v2x/ossm-architecture.adoc
-// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
+// * observability/distr_tracing/distr-tracing-architecture.adoc
 
 [id="distr-tracing-features_{context}"]
 = {DTProductName} features

modules/distr-tracing-product-overview.adoc

@@ -2,7 +2,7 @@
 //
 // * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc
 // * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
-// * observability/distr_tracing_arch/distr-tracing-architecture.adoc
+// * observability/distr-tracing-architecture.adoc
 // * service_mesh/v2x/ossm-architecture.adoc
 // * serverless/serverless-tracing.adoc
 

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

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}"]

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

modules/distr-tracing-tempo-config-default.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
+// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-tempo-config-default_{context}"]

modules/distr-tracing-tempo-config-query-frontend.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
+// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-tempo-config-query_{context}"]