chore: Sync markdown to DITA, volume 2 (kyma-project#1255)

Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com> Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>
NHingerl · Jul 17, 2024 · 5ff62a8 · 5ff62a8
1 parent 22034b6
commit 5ff62a8
Show file tree

Hide file tree

Showing 8 changed files with 535 additions and 572 deletions.
diff --git a/docs/user/02-logs.md b/docs/user/02-logs.md
diff --git a/docs/user/03-traces.md b/docs/user/03-traces.md
diff --git a/docs/user/04-metrics.md b/docs/user/04-metrics.md
diff --git a/docs/user/README.md b/docs/user/README.md
@@ -27,7 +27,7 @@ To support telemetry for your applications, the Telemetry module provides the fo
 - Guidance for the instrumentation (traces and metrics only): Based on [Open Telemetry](https://opentelemetry.io/), you get community samples on how to instrument your code using the [Open Telemetry SDKs](https://opentelemetry.io/docs/instrumentation/) in nearly every programming language.
 - Enriching telemetry data by automatically adding common attributes. This is done in compliance with established semantic conventions, ensuring that the enriched data adheres to industry best practices and is more meaningful for analysis. For details, see [Data Enrichment](gateways.md#data-enrichment).
 - Opt-out of features for advanced scenarios: At any time, you can opt out for each data type, and use custom tooling to collect and ship the telemetry data.
-- SAP BTP as first-class integration: Integration into BTP Observability services, such as SAP Cloud Logging is prioritized. For more information, see [SAP Cloud Logging](integration/sap-cloud-logging/README.md). <!--- replace with Help Portal link once published? --->
+- SAP BTP as first-class integration: Integration into SAP BTP Observability services, such as SAP Cloud Logging, is prioritized. For more information, see [SAP Cloud Logging](integration/sap-cloud-logging/README.md). <!--- replace with Help Portal link once published? --->
 
 ## Scope
 

diff --git a/docs/user/gateways.md b/docs/user/gateways.md
@@ -10,7 +10,7 @@ Both, the traces and the metrics feature, are based on a gateway, which is provi
 - Filtering to apply namespace filtering and remove noisy system data (individually for logs, traces, and metrics)
 - Dispatching to the configured backends (individually for logs, traces, and metrics)
 
-When the Istio module is added to your Kyma cluster, the gateways support mTLS for the communication from the workload to the gateway, as well as for communication to backends running in the cluster. For details, see [Istio support](#istio-support).
+When the Istio module is added to your Kyma cluster, the gateways support mTLS for the communication from the workload to the gateway, as well as for communication to backends running in the cluster. For details, see [Istio Support](#istio-support).
 
 The gateways are based on the [OTel Collector](https://opentelemetry.io/docs/collector/) and come with a concept of pipelines consisting of receivers, processors, and exporters, with which you can flexibly plug pipelines together (see [Configuration](https://opentelemetry.io/docs/collector/configuration/)). Kyma's MetricPipeline provides a hardened setup of an OTel Collector and also abstracts the underlying pipeline concept. Such abstraction has the following benefits:
 
@@ -23,7 +23,7 @@ The Telemetry module focuses on full configurability of backends integrated by O
 
 ## Data Enrichment
 
-The Telemetry gateways automatically enrich your data by adding the attributes:
+The Telemetry gateways automatically enrich your data by adding the following attributes:
 
 - `service.name`: The logical name of the service that emits the telemetry data. The gateway ensures that this attribute always has a valid value.
   If not provided by the user, or if its value follows the pattern `unknown_service:<process.executable.name>` as described in the [specification](https://opentelemetry.io/docs/specs/semconv/resource/#service), then it is generated from Kubernetes metadata. The gateway determines the service name based on the following hierarchy of labels and names:

diff --git a/docs/user/integration/jaeger/README.md b/docs/user/integration/jaeger/README.md
@@ -90,7 +90,7 @@ EOF
 
 ### Activate Istio Tracing
 
-To [enable Istio](../../03-traces.md#step-2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
+To [enable Istio](../../03-traces.md#2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
 
 ```bash
 cat <<EOF | kubectl apply -f -

diff --git a/docs/user/integration/opentelemetry-demo/README.md b/docs/user/integration/opentelemetry-demo/README.md
@@ -66,7 +66,7 @@ Learn how to install the OpenTelemetry [demo application](https://github.com/ope
 1. Provide a tracing backend and activate it.
    Install [Jaeger in-cluster](../jaeger/README.md) or provide a custom backend supporting the OTLP protocol.
 2. Activate the Istio tracing feature.
-To [enable Istio](../../03-traces.md#step-2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
+To [enable Istio](../../03-traces.md#2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
 
    ```bash
    cat <<EOF | kubectl apply -f -

diff --git a/docs/user/integration/sap-cloud-logging/README.md b/docs/user/integration/sap-cloud-logging/README.md