Skip to content

Commit bfa8f77

Browse files
max-cxmax-cx
committed
OBSDOCS-1629: Flatten the Distributed tracing docs structure
1 parent fe997ef commit bfa8f77

File tree

52 files changed

+162
-154
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+162
-154
lines changed

‎_attributes/common-attributes.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,20 @@ ifdef::openshift-origin[]
116116
:CNVSubscriptionSpecName: community-kubevirt-hyperconverged
117117
endif::[]
118118
// distributed tracing
119-
:DTProductName: Red Hat OpenShift distributed tracing platform
120-
:DTShortName: distributed tracing platform
119+
:DTProductName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
120+
:DTShortName: Distributed Tracing Platform
121121
:DTProductVersion: 3.1
122-
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
123-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
124-
:JaegerShortName: distributed tracing platform (Jaeger)
125-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
122+
:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
123+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
124+
:JaegerShortName: Distributed Tracing Platform (Jaeger)
125+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
126126
:JaegerVersion: 1.53.0
127127
:OTELName: Red Hat build of OpenTelemetry
128128
:OTELShortName: Red Hat build of OpenTelemetry
129129
:OTELOperator: Red Hat build of OpenTelemetry Operator
130130
:OTELVersion: 0.93.0
131-
:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
132-
:TempoShortName: distributed tracing platform (Tempo)
131+
:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
132+
:TempoShortName: Distributed Tracing Platform
133133
:TempoOperator: Tempo Operator
134134
:TempoVersion: 2.3.1
135135
// telco

‎_topic_maps/_topic_map.yml

+29-35
Original file line numberDiff line numberDiff line change
@@ -2949,52 +2949,46 @@ Topics:
29492949
# File: logging-5-8-reference
29502950
# - Name: 5.7 Logging API reference
29512951
# File: logging-5-7-reference
2952-
- Name: 5.6 Logging API reference
2953-
File: logging-5-6-reference
2954-
- Name: Glossary
2955-
File: logging-common-terms
2956-
- Name: Distributed tracing
2952+
# - Name: 5.6 Logging API reference
2953+
# File: logging-5-6-reference
2954+
# - Name: Glossary
2955+
# File: logging-common-terms
2956+
- Name: Distributed Tracing
29572957
Dir: distr_tracing
29582958
Distros: openshift-enterprise
29592959
Topics:
2960-
- Name: Release notes
2960+
- Name: Release notes for the Distributed Tracing Platform
29612961
File: distr-tracing-rn
2962-
- Name: Distributed tracing architecture
2963-
Dir: distr_tracing_arch
2964-
Topics:
2965-
- Name: Distributed tracing architecture
2966-
File: distr-tracing-architecture
2967-
- Name: Distributed tracing platform (Tempo)
2968-
Dir: distr_tracing_tempo
2969-
Topics:
2970-
- Name: Installing
2971-
File: distr-tracing-tempo-installing
2972-
- Name: Configuring
2973-
File: distr-tracing-tempo-configuring
2974-
- Name: Troubleshooting
2975-
File: distr-tracing-tempo-troubleshooting
2976-
- Name: Upgrading
2977-
File: distr-tracing-tempo-updating
2978-
- Name: Removing
2979-
File: distr-tracing-tempo-removing
2980-
- Name: Distributed tracing platform (Jaeger)
2962+
- Name: About the Distributed Tracing Platform
2963+
File: distr-tracing-architecture
2964+
- Name: Installing the Distributed Tracing Platform
2965+
File: distr-tracing-tempo-installing
2966+
- Name: Configuring the Distributed Tracing Platform
2967+
File: distr-tracing-tempo-configuring
2968+
- Name: Troubleshooting the Distributed Tracing Platform
2969+
File: distr-tracing-tempo-troubleshooting
2970+
- Name: Upgrading the Distributed Tracing Platform
2971+
File: distr-tracing-tempo-updating
2972+
- Name: Removing the Distributed Tracing Platform
2973+
File: distr-tracing-tempo-removing
2974+
- Name: Distributed Tracing Platform (Jaeger)
29812975
Dir: distr_tracing_jaeger
29822976
Topics:
2983-
- Name: Installing
2977+
- Name: Installing the Distributed Tracing Platform (Jaeger)
29842978
File: distr-tracing-jaeger-installing
2985-
- Name: Configuring
2979+
- Name: Configuring the Distributed Tracing Platform (Jaeger)
29862980
File: distr-tracing-jaeger-configuring
2987-
- Name: Upgrading
2981+
- Name: Upgrading the Distributed Tracing Platform (Jaeger)
29882982
File: distr-tracing-jaeger-updating
2989-
- Name: Removing
2983+
- Name: Removing the Distributed Tracing Platform (Jaeger)
29902984
File: distr-tracing-jaeger-removing
29912985
- Name: Red Hat build of OpenTelemetry
29922986
Dir: otel
29932987
Distros: openshift-enterprise
29942988
Topics:
2995-
- Name: Release notes
2989+
- Name: Release notes for the Red Hat build of OpenTelemetry
29962990
File: otel-rn
2997-
- Name: Installing
2991+
- Name: Installing the Red Hat build of OpenTelemetry
29982992
File: otel-installing
29992993
- Name: Configuring the Collector
30002994
Dir: otel-collector
@@ -3025,13 +3019,13 @@ Topics:
30253019
File: otel-configuring-otelcol-metrics
30263020
- Name: Gathering the observability data from multiple clusters
30273021
File: otel-config-multicluster
3028-
- Name: Troubleshooting
3022+
- Name: Troubleshooting the Red Hat build of OpenTelemetry
30293023
File: otel-troubleshooting
3030-
- Name: Migrating
3024+
- Name: Migrating to the Red Hat build of OpenTelemetry
30313025
File: otel-migrating
3032-
- Name: Upgrading
3026+
- Name: Upgrading the Red Hat build of OpenTelemetry
30333027
File: otel-updating
3034-
- Name: Removing
3028+
- Name: Removing the Red Hat build of OpenTelemetry
30353029
File: otel-removing
30363030
- Name: Network Observability
30373031
Dir: network_observability

‎modules/distr-tracing-architecture.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * service_mesh/v2x/ossm-architecture.adoc
4-
// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
4+
// * observability/distr_tracing/distr-tracing-architecture.adoc
55

66
:_mod-docs-content-type: CONCEPT
77
[id="distr-tracing-architecture_{context}"]
@@ -27,6 +27,8 @@
2727
2828
** *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.
2929

30+
// when removing the Jaeger docs, remove all the following lines to the end of the file
31+
3032
* *{JaegerName}* - This component is based on the open source link:https://www.jaegertracing.io/[Jaeger project].
3133
+
3234
:FeatureName: The {JaegerName}

‎modules/distr-tracing-features.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * service_mesh/v2x/ossm-architecture.adoc
4-
// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
4+
// * observability/distr_tracing/distr-tracing-architecture.adoc
55

66
[id="distr-tracing-features_{context}"]
77
= {DTProductName} features

‎modules/distr-tracing-product-overview.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc
44
// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
5-
// * observability/distr_tracing_arch/distr-tracing-architecture.adoc
5+
// * observability/distr-tracing-architecture.adoc
66
// * service_mesh/v2x/ossm-architecture.adoc
77
// * serverless/serverless-tracing.adoc
88

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-tempo-config-default_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-tempo-config-query_{context}"]

‎modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-tempo-config-receiver-tls-for-tempomonolithic_{context}"]

‎modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-tempo-config-receiver-tls-for-tempostack_{context}"]

‎modules/distr-tracing-tempo-config-spanmetrics.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-config-spanmetrics_{context}"]

‎modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="configuring-tempooperator-metrics-and-alerts_{context}"]

‎modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="configuring-tempostack-metrics-and-alerts_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-cli_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-gateway-read-permissions_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-gateway-write-permissions_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-tempomonolithic-cli_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-tempomonolithic-web-console_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-tempostack-cli_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-tempostack-web-console_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-install-web-console_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-object-storage-setup-aws-sts-install_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-object-storage-setup-ibm-storage_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//Module included in the following assemblies:
22
//
3-
//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
3+
//* observability/distr_tracing/dist-tracing-tempo-removing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-removing-tempo-instance-cli_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//Module included in the following assemblies:
22
//
3-
//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
3+
//* observability/distr_tracing/dist-tracing-tempo-removing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-removing-tempo-instance_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
3+
//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-tempo-object-storage-setup_{context}"]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc
3+
// * observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-tempo-collecting-diagnostic-data-from-command-line_{context}"]

‎modules/otel-config-receive-metrics-monitoring-stack.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ kind: ConfigMap
2828
apiVersion: v1
2929
metadata:
3030
name: cabundle
31-
namespce: observability
31+
namespace: observability
3232
annotations:
3333
service.beta.openshift.io/inject-cabundle: "true" # <2>
3434
---

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="distr-tracing-architecture"]
3-
= Distributed tracing architecture
3+
= About the {DTShortName}
44
include::_attributes/common-attributes.adoc[]
55
:context: distributed-tracing-architecture
66

@@ -28,4 +28,4 @@ include::modules/distr-tracing-architecture.adoc[leveloffset=+1]
2828
== Additional resources
2929

3030
// 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
31-
* xref:../../otel/otel-installing.adoc#install-otel[{OTELName}]
31+
* xref:../otel/otel-installing.adoc#install-otel[{OTELName}]

0 commit comments

Comments
 (0)