Skip to content

Commit d06586e

Browse files
max-cxmax-cx
committed
OBSDOCS-1629: Flatten the Distributed tracing docs structure
1 parent 2c13276 commit d06586e

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
@@ -112,20 +112,20 @@ ifdef::openshift-origin[]
112112
:CNVSubscriptionSpecName: community-kubevirt-hyperconverged
113113
endif::[]
114114
// distributed tracing
115-
:DTProductName: Red Hat OpenShift distributed tracing platform
116-
:DTShortName: distributed tracing platform
115+
:DTProductName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
116+
:DTShortName: Distributed Tracing Platform
117117
:DTProductVersion: 3.1
118-
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
119-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
120-
:JaegerShortName: distributed tracing platform (Jaeger)
121-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
118+
:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
119+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
120+
:JaegerShortName: Distributed Tracing Platform (Jaeger)
121+
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
122122
:JaegerVersion: 1.53.0
123123
:OTELName: Red Hat build of OpenTelemetry
124124
:OTELShortName: Red Hat build of OpenTelemetry
125125
:OTELOperator: Red Hat build of OpenTelemetry Operator
126126
:OTELVersion: 0.93.0
127-
:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
128-
:TempoShortName: distributed tracing platform (Tempo)
127+
:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform
128+
:TempoShortName: Distributed Tracing Platform
129129
:TempoOperator: Tempo Operator
130130
:TempoVersion: 2.3.1
131131
// telco

‎_topic_maps/_topic_map.yml

+29-35
Original file line numberDiff line numberDiff line change
@@ -3022,52 +3022,46 @@ Topics:
30223022
# File: logging-5-8-reference
30233023
# - Name: 5.7 Logging API reference
30243024
# File: logging-5-7-reference
3025-
- Name: 5.6 Logging API reference
3026-
File: logging-5-6-reference
3027-
- Name: Glossary
3028-
File: logging-common-terms
3029-
- Name: Distributed tracing
3025+
# - Name: 5.6 Logging API reference
3026+
# File: logging-5-6-reference
3027+
# - Name: Glossary
3028+
# File: logging-common-terms
3029+
- Name: Distributed Tracing
30303030
Dir: distr_tracing
30313031
Distros: openshift-enterprise
30323032
Topics:
3033-
- Name: Release notes
3033+
- Name: Release notes for the Distributed Tracing Platform
30343034
File: distr-tracing-rn
3035-
- Name: Distributed tracing architecture
3036-
Dir: distr_tracing_arch
3037-
Topics:
3038-
- Name: Distributed tracing architecture
3039-
File: distr-tracing-architecture
3040-
- Name: Distributed tracing platform (Tempo)
3041-
Dir: distr_tracing_tempo
3042-
Topics:
3043-
- Name: Installing
3044-
File: distr-tracing-tempo-installing
3045-
- Name: Configuring
3046-
File: distr-tracing-tempo-configuring
3047-
- Name: Troubleshooting
3048-
File: distr-tracing-tempo-troubleshooting
3049-
- Name: Upgrading
3050-
File: distr-tracing-tempo-updating
3051-
- Name: Removing
3052-
File: distr-tracing-tempo-removing
3053-
- Name: Distributed tracing platform (Jaeger)
3035+
- Name: About the Distributed Tracing Platform
3036+
File: distr-tracing-architecture
3037+
- Name: Installing the Distributed Tracing Platform
3038+
File: distr-tracing-tempo-installing
3039+
- Name: Configuring the Distributed Tracing Platform
3040+
File: distr-tracing-tempo-configuring
3041+
- Name: Troubleshooting the Distributed Tracing Platform
3042+
File: distr-tracing-tempo-troubleshooting
3043+
- Name: Upgrading the Distributed Tracing Platform
3044+
File: distr-tracing-tempo-updating
3045+
- Name: Removing the Distributed Tracing Platform
3046+
File: distr-tracing-tempo-removing
3047+
- Name: Distributed Tracing Platform (Jaeger)
30543048
Dir: distr_tracing_jaeger
30553049
Topics:
3056-
- Name: Installing
3050+
- Name: Installing the Distributed Tracing Platform (Jaeger)
30573051
File: distr-tracing-jaeger-installing
3058-
- Name: Configuring
3052+
- Name: Configuring the Distributed Tracing Platform (Jaeger)
30593053
File: distr-tracing-jaeger-configuring
3060-
- Name: Upgrading
3054+
- Name: Upgrading the Distributed Tracing Platform (Jaeger)
30613055
File: distr-tracing-jaeger-updating
3062-
- Name: Removing
3056+
- Name: Removing the Distributed Tracing Platform (Jaeger)
30633057
File: distr-tracing-jaeger-removing
30643058
- Name: Red Hat build of OpenTelemetry
30653059
Dir: otel
30663060
Distros: openshift-enterprise
30673061
Topics:
3068-
- Name: Release notes
3062+
- Name: Release notes for the Red Hat build of OpenTelemetry
30693063
File: otel-rn
3070-
- Name: Installing
3064+
- Name: Installing the Red Hat build of OpenTelemetry
30713065
File: otel-installing
30723066
- Name: Configuring the Collector
30733067
Dir: otel-collector
@@ -3098,13 +3092,13 @@ Topics:
30983092
File: otel-configuring-otelcol-metrics
30993093
- Name: Gathering the observability data from multiple clusters
31003094
File: otel-config-multicluster
3101-
- Name: Troubleshooting
3095+
- Name: Troubleshooting the Red Hat build of OpenTelemetry
31023096
File: otel-troubleshooting
3103-
- Name: Migrating
3097+
- Name: Migrating to the Red Hat build of OpenTelemetry
31043098
File: otel-migrating
3105-
- Name: Upgrading
3099+
- Name: Upgrading the Red Hat build of OpenTelemetry
31063100
File: otel-updating
3107-
- Name: Removing
3101+
- Name: Removing the Red Hat build of OpenTelemetry
31083102
File: otel-removing
31093103
- Name: Network Observability
31103104
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)