Skip to content

Commit c9116c0

Browse files
max-cxmax-cx
committed
OBSDOCS-1629: Flatten the Distributed tracing docs structure
1 parent 005ba1a commit c9116c0

File tree

53 files changed

+160
-152
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

+160
-152
lines changed

‎_attributes/common-attributes.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -122,20 +122,20 @@ endif::[]
122122
:ove-first: Red Hat OpenShift Virtualization Engine
123123
:ove: OpenShift Virtualization Engine
124124
//distributed tracing
125-
:DTProductName: Red Hat OpenShift distributed tracing platform
126-
:DTShortName: distributed tracing platform
125+
:DTProductName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
126+
:DTShortName: Distributed Tracing Platform
127127
:DTProductVersion: 3.1
128-
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
129-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
130-
:JaegerShortName: distributed tracing platform (Jaeger)
131-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
128+
:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
129+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
130+
:JaegerShortName: Distributed Tracing Platform (Jaeger)
131+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
132132
:JaegerVersion: 1.53.0
133133
:OTELName: Red Hat build of OpenTelemetry
134134
:OTELShortName: Red Hat build of OpenTelemetry
135135
:OTELOperator: Red Hat build of OpenTelemetry Operator
136136
:OTELVersion: 0.93.0
137-
:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
138-
:TempoShortName: distributed tracing platform (Tempo)
137+
:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
138+
:TempoShortName: Distributed Tracing Platform
139139
:TempoOperator: Tempo Operator
140140
:TempoVersion: 2.3.1
141141
//telco

‎_topic_maps/_topic_map.yml

+25-31
Original file line numberDiff line numberDiff line change
@@ -3180,48 +3180,42 @@ Topics:
31803180
# File: logging-5-6-reference
31813181
# - Name: Glossary
31823182
# File: logging-common-terms
3183-
- Name: Distributed tracing
3183+
- Name: Distributed Tracing
31843184
Dir: distr_tracing
31853185
Distros: openshift-enterprise
31863186
Topics:
3187-
- Name: Release notes
3187+
- Name: Release notes for the Distributed Tracing Platform
31883188
File: distr-tracing-rn
3189-
- Name: Distributed tracing architecture
3190-
Dir: distr_tracing_arch
3191-
Topics:
3192-
- Name: Distributed tracing architecture
3193-
File: distr-tracing-architecture
3194-
- Name: Distributed tracing platform (Tempo)
3195-
Dir: distr_tracing_tempo
3196-
Topics:
3197-
- Name: Installing
3198-
File: distr-tracing-tempo-installing
3199-
- Name: Configuring
3200-
File: distr-tracing-tempo-configuring
3201-
- Name: Troubleshooting
3202-
File: distr-tracing-tempo-troubleshooting
3203-
- Name: Upgrading
3204-
File: distr-tracing-tempo-updating
3205-
- Name: Removing
3206-
File: distr-tracing-tempo-removing
3207-
- Name: Distributed tracing platform (Jaeger)
3189+
- Name: About the Distributed Tracing Platform
3190+
File: distr-tracing-architecture
3191+
- Name: Installing the Distributed Tracing Platform
3192+
File: distr-tracing-tempo-installing
3193+
- Name: Configuring the Distributed Tracing Platform
3194+
File: distr-tracing-tempo-configuring
3195+
- Name: Troubleshooting the Distributed Tracing Platform
3196+
File: distr-tracing-tempo-troubleshooting
3197+
- Name: Upgrading the Distributed Tracing Platform
3198+
File: distr-tracing-tempo-updating
3199+
- Name: Removing the Distributed Tracing Platform
3200+
File: distr-tracing-tempo-removing
3201+
- Name: Distributed Tracing Platform (Jaeger)
32083202
Dir: distr_tracing_jaeger
32093203
Topics:
3210-
- Name: Installing
3204+
- Name: Installing the Distributed Tracing Platform (Jaeger)
32113205
File: distr-tracing-jaeger-installing
3212-
- Name: Configuring
3206+
- Name: Configuring the Distributed Tracing Platform (Jaeger)
32133207
File: distr-tracing-jaeger-configuring
3214-
- Name: Upgrading
3208+
- Name: Upgrading the Distributed Tracing Platform (Jaeger)
32153209
File: distr-tracing-jaeger-updating
3216-
- Name: Removing
3210+
- Name: Removing the Distributed Tracing Platform (Jaeger)
32173211
File: distr-tracing-jaeger-removing
32183212
- Name: Red Hat build of OpenTelemetry
32193213
Dir: otel
32203214
Distros: openshift-enterprise
32213215
Topics:
3222-
- Name: Release notes
3216+
- Name: Release notes for the Red Hat build of OpenTelemetry
32233217
File: otel-rn
3224-
- Name: Installing
3218+
- Name: Installing the Red Hat build of OpenTelemetry
32253219
File: otel-installing
32263220
- Name: Configuring the Collector
32273221
Dir: otel-collector
@@ -3252,13 +3246,13 @@ Topics:
32523246
File: otel-configuring-otelcol-metrics
32533247
- Name: Gathering the observability data from multiple clusters
32543248
File: otel-config-multicluster
3255-
- Name: Troubleshooting
3249+
- Name: Troubleshooting the Red Hat build of OpenTelemetry
32563250
File: otel-troubleshooting
3257-
- Name: Migrating
3251+
- Name: Migrating to the Red Hat build of OpenTelemetry
32583252
File: otel-migrating
3259-
- Name: Upgrading
3253+
- Name: Upgrading the Red Hat build of OpenTelemetry
32603254
File: otel-updating
3261-
- Name: Removing
3255+
- Name: Removing the Red Hat build of OpenTelemetry
32623256
File: otel-removing
32633257
- Name: Network Observability
32643258
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)