OBSDOCS-1629: Flatten the Distributed tracing docs structure

Author: max-cx

_attributes/common-attributes.adoc

@@ -127,20 +127,20 @@ endif::[]
 :ove-first: Red{nbsp}Hat OpenShift Virtualization Engine
 :ove: OpenShift Virtualization Engine
 //distributed tracing
-:DTProductName: Red{nbsp}Hat OpenShift distributed tracing platform
-:DTShortName: distributed tracing platform
+:DTProductName: Red{nbsp}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
-:JaegerShortName: distributed tracing platform (Jaeger)
-:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
+:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
+:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
+:JaegerShortName: Distributed Tracing Platform (Jaeger)
+:JaegerOperator: Red{nbsp}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 (Tempo)
-:TempoShortName: distributed tracing platform (Tempo)
+:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
+:TempoShortName: Distributed Tracing Platform
 :TempoOperator: Tempo Operator
 :TempoVersion: 2.3.1
 //telco

_topic_maps/_topic_map.yml

@@ -3172,46 +3172,40 @@ 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 of the {DTShortName}
     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 of the {OTELName}
     File: otel-rn
   - Name: Installing
     File: otel-installing

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

modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.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-receiver-tls-for-tempomonolithic_{context}"]

modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.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-receiver-tls-for-tempostack_{context}"]

modules/distr-tracing-tempo-config-spanmetrics.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: PROCEDURE
 [id="distr-tracing-tempo-config-spanmetrics_{context}"]

modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.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: PROCEDURE
 [id="configuring-tempooperator-metrics-and-alerts_{context}"]

modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.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: PROCEDURE
 [id="configuring-tempostack-metrics-and-alerts_{context}"]

modules/distr-tracing-tempo-install-cli.adoc

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

modules/distr-tracing-tempo-install-gateway-read-permissions.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-gateway-read-permissions_{context}"]

modules/distr-tracing-tempo-install-gateway-write-permissions.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-gateway-write-permissions_{context}"]

modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-tempomonolithic-cli_{context}"]

modules/distr-tracing-tempo-install-tempomonolithic-web-console.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-tempomonolithic-web-console_{context}"]

modules/distr-tracing-tempo-install-tempostack-cli.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-tempostack-cli_{context}"]

modules/distr-tracing-tempo-install-tempostack-web-console.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-tempostack-web-console_{context}"]

modules/distr-tracing-tempo-install-web-console.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-install-web-console_{context}"]

modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-object-storage-setup-aws-sts-install_{context}"]

modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-object-storage-setup-ibm-storage_{context}"]

modules/distr-tracing-tempo-remove-cli.adoc

@@ -1,6 +1,6 @@
 //Module included in the following assemblies:
 //
-//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
+//* observability/distr_tracing/dist-tracing-tempo-removing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-removing-tempo-instance-cli_{context}"]

modules/distr-tracing-tempo-remove-web-console.adoc

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

modules/distr-tracing-tempo-storage-ref.adoc

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

modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc
+// * observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-tempo-collecting-diagnostic-data-from-command-line_{context}"]

observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc renamed to observability/distr_tracing/distr-tracing-architecture.adoc

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="distr-tracing-architecture"]
-= Distributed tracing architecture
+= About the {DTShortName}
 include::_attributes/common-attributes.adoc[]
 :context: distributed-tracing-architecture
 
@@ -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:../otel/otel-installing.adoc#install-otel[{OTELName}]

observability/distr_tracing/distr-tracing-rn.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
 include::_attributes/common-attributes.adoc[]
 [id="distr-tracing-rn"]
-= Release notes for the {DTProductName}
+= Release notes of the {DTShortName}
 :context: distr-tracing-rn
 
 toc::[]
@@ -121,7 +121,7 @@ You must migrate to the {OTELName} Operator and the {TempoOperator} for distribu
 
 * xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation)
 
-* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] ({TempoShortName} documentation)
+* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] ({TempoShortName} documentation)
 
 * link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase solution)
 
@@ -148,7 +148,7 @@ The {JaegerName} 3.5 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
 * link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase)
 * xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] ({OTELName} documentation)
 * xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation)
-* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] (Distributed tracing platform (Tempo) documentation)
+* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] ({DTShortName} documentation)
 
 ////
 [id="distr-tracing_3-5_jaeger-release-notes_bug-fixes_{context}"]
@@ -268,14 +268,14 @@ Red{nbsp}Hat will provide support for these components and fixes for CVEs and bu
 
 The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operators` catalog in a future release. For more information, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift].
 
-You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] in the {TempoShortName} documentation.
+You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] in the {TempoShortName} documentation.
 
 [role="_additional-resources"]
 .Additional resources
 * link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift (Red Hat Knowledgebase)]
 * xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating ({OTELName} documentation)]
 * xref:../../observability/otel/otel-installing.adoc#install-otel[Installing ({OTELName} documentation)]
-* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing (Distributed tracing platform (Tempo) documentation)]
+* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing ({DTShortName} documentation)]
 
 [id="distr-tracing_3-4_jaeger-release-notes_bug-fixes_{context}"]
 ==== Bug fixes
@@ -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#dist-tracing-otel-migrating[migrate] to the xref:distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-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:../otel/otel-migrating.adoc#dist-tracing-otel-migrating[migrate] to the xref:distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[{TempoOperator}] and the xref:../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#dist-tracing-otel-migrating[migrate] to the xref:distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-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:../otel/otel-migrating.adoc#dist-tracing-otel-migrating[migrate] to the xref:distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage.
 
 ////
 [id="distr-tracing_3-3_jaeger-release-notes_removal-notice_{context}"]