Skip to content

Commit 146182b

Browse files
committed
OBSDOCS-1629: Flatten the Distributed tracing docs structure
1 parent f055de4 commit 146182b

File tree

53 files changed

+159
-151
lines changed

Some content is hidden

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

53 files changed

+159
-151
lines changed

_attributes/common-attributes.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,20 +127,20 @@ endif::[]
127127
:ove-first: Red{nbsp}Hat OpenShift Virtualization Engine
128128
:ove: OpenShift Virtualization Engine
129129
//distributed tracing
130-
:DTProductName: Red{nbsp}Hat OpenShift distributed tracing platform
131-
:DTShortName: distributed tracing platform
130+
:DTProductName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
131+
:DTShortName: Distributed Tracing Platform
132132
:DTProductVersion: 3.1
133-
:JaegerName: Red{nbsp}Hat OpenShift distributed tracing platform (Jaeger)
134-
:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
135-
:JaegerShortName: distributed tracing platform (Jaeger)
136-
:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
133+
:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
134+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
135+
:JaegerShortName: Distributed Tracing Platform (Jaeger)
136+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
137137
:JaegerVersion: 1.53.0
138138
:OTELName: Red{nbsp}Hat build of OpenTelemetry
139139
:OTELShortName: Red{nbsp}Hat build of OpenTelemetry
140140
:OTELOperator: Red{nbsp}Hat build of OpenTelemetry Operator
141141
:OTELVersion: 0.93.0
142-
:TempoName: Red{nbsp}Hat OpenShift distributed tracing platform (Tempo)
143-
:TempoShortName: distributed tracing platform (Tempo)
142+
:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
143+
:TempoShortName: Distributed Tracing Platform
144144
:TempoOperator: Tempo Operator
145145
:TempoVersion: 2.3.1
146146
//telco

_topic_maps/_topic_map.yml

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3172,48 +3172,42 @@ Topics:
31723172
# File: logging-5-6-reference
31733173
# - Name: Glossary
31743174
# File: logging-common-terms
3175-
- Name: Distributed tracing
3175+
- Name: Distributed Tracing
31763176
Dir: distr_tracing
31773177
Distros: openshift-enterprise
31783178
Topics:
3179-
- Name: Release notes
3179+
- Name: Release notes for the Distributed Tracing Platform
31803180
File: distr-tracing-rn
3181-
- Name: Distributed tracing architecture
3182-
Dir: distr_tracing_arch
3183-
Topics:
3184-
- Name: Distributed tracing architecture
3185-
File: distr-tracing-architecture
3186-
- Name: Distributed tracing platform (Tempo)
3187-
Dir: distr_tracing_tempo
3188-
Topics:
3189-
- Name: Installing
3190-
File: distr-tracing-tempo-installing
3191-
- Name: Configuring
3192-
File: distr-tracing-tempo-configuring
3193-
- Name: Troubleshooting
3194-
File: distr-tracing-tempo-troubleshooting
3195-
- Name: Upgrading
3196-
File: distr-tracing-tempo-updating
3197-
- Name: Removing
3198-
File: distr-tracing-tempo-removing
3199-
- Name: Distributed tracing platform (Jaeger)
3181+
- Name: About the Distributed Tracing Platform
3182+
File: distr-tracing-architecture
3183+
- Name: Installing the Distributed Tracing Platform
3184+
File: distr-tracing-tempo-installing
3185+
- Name: Configuring the Distributed Tracing Platform
3186+
File: distr-tracing-tempo-configuring
3187+
- Name: Troubleshooting the Distributed Tracing Platform
3188+
File: distr-tracing-tempo-troubleshooting
3189+
- Name: Upgrading the Distributed Tracing Platform
3190+
File: distr-tracing-tempo-updating
3191+
- Name: Removing the Distributed Tracing Platform
3192+
File: distr-tracing-tempo-removing
3193+
- Name: Distributed Tracing Platform (Jaeger)
32003194
Dir: distr_tracing_jaeger
32013195
Topics:
3202-
- Name: Installing
3196+
- Name: Installing the Distributed Tracing Platform (Jaeger)
32033197
File: distr-tracing-jaeger-installing
3204-
- Name: Configuring
3198+
- Name: Configuring the Distributed Tracing Platform (Jaeger)
32053199
File: distr-tracing-jaeger-configuring
3206-
- Name: Upgrading
3200+
- Name: Upgrading the Distributed Tracing Platform (Jaeger)
32073201
File: distr-tracing-jaeger-updating
3208-
- Name: Removing
3202+
- Name: Removing the Distributed Tracing Platform (Jaeger)
32093203
File: distr-tracing-jaeger-removing
32103204
- Name: Red Hat build of OpenTelemetry
32113205
Dir: otel
32123206
Distros: openshift-enterprise
32133207
Topics:
3214-
- Name: Release notes
3208+
- Name: Release notes for the Red Hat build of OpenTelemetry
32153209
File: otel-rn
3216-
- Name: Installing
3210+
- Name: Installing the Red Hat build of OpenTelemetry
32173211
File: otel-installing
32183212
- Name: Configuring the Collector
32193213
Dir: otel-collector
@@ -3244,13 +3238,13 @@ Topics:
32443238
File: otel-configuring-otelcol-metrics
32453239
- Name: Gathering the observability data from multiple clusters
32463240
File: otel-config-multicluster
3247-
- Name: Troubleshooting
3241+
- Name: Troubleshooting the Red Hat build of OpenTelemetry
32483242
File: otel-troubleshooting
3249-
- Name: Migrating
3243+
- Name: Migrating to the Red Hat build of OpenTelemetry
32503244
File: otel-migrating
3251-
- Name: Upgrading
3245+
- Name: Upgrading the Red Hat build of OpenTelemetry
32523246
File: otel-updating
3253-
- Name: Removing
3247+
- Name: Removing the Red Hat build of OpenTelemetry
32543248
File: otel-removing
32553249
- Name: Network Observability
32563250
Dir: network_observability

modules/distr-tracing-architecture.adoc

Lines changed: 3 additions & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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}"]

0 commit comments

Comments
 (0)