docs: Implement TW Review (kyma-project#1323)

NHingerl · Aug 6, 2024 · 05ab9b0 · 05ab9b0
1 parent 795ba92
commit 05ab9b0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/user/02-logs.md b/docs/user/02-logs.md
@@ -6,7 +6,7 @@ With application logs, you can debug an application and derive the internal stat
 
 The Telemetry module provides the [Fluent Bit](https://fluentbit.io/) log agent for the collection and shipment of application logs of any container running in the Kyma runtime.
 
-You can configure the log agent with external systems using runtime configuration with a dedicated Kubernetes API (CRD) named `LogPipeline`. With the LogPipeline's HTTP output, you can natively integrate with vendors that support this output, or with any vendor using a [Fluentd integration](https://medium.com/hepsiburadatech/fluent-logging-architecture-fluent-bit-fluentd-elasticsearch-ca4a898e28aa).
+You can configure the log agent with external systems using runtime configuration with a dedicated Kubernetes API ([CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)) named `LogPipeline`. With the LogPipeline's HTTP output, you can natively integrate with vendors that support this output, or with any vendor using a [Fluentd integration](https://medium.com/hepsiburadatech/fluent-logging-architecture-fluent-bit-fluentd-elasticsearch-ca4a898e28aa).
 
 The feature is optional, if you don't want to use the Logs feature, simply don't set up a LogPipeline.
 

diff --git a/docs/user/03-traces.md b/docs/user/03-traces.md
@@ -14,7 +14,7 @@ The following diagram shows how distributed tracing helps to track the request p
 
 The Telemetry module provides a trace gateway for the shipment of traces of any container running in the Kyma runtime.
 
-You can configure the trace gateway with external systems using runtime configuration with a dedicated Kubernetes API (CRD) named TracePipeline.
+You can configure the trace gateway with external systems using runtime configuration with a dedicated Kubernetes API ([CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)) named TracePipeline.
 The Trace feature is optional. If you don't want to use it, simply don't set up a TracePipeline.
 
 ## Prerequisites

diff --git a/docs/user/04-metrics.md b/docs/user/04-metrics.md
@@ -9,7 +9,7 @@ While application logs and traces usually provide request-oriented data, metrics
 
 The Telemetry module provides a metric gateway and, optionally, an agent for the collection and shipment of metrics of any container running in the Kyma runtime.
 
-You can configure the metric gateway with external systems using runtime configuration with a dedicated Kubernetes API (CRD) named MetricPipeline.
+You can configure the metric gateway with external systems using runtime configuration with a dedicated Kubernetes API ([CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)) named MetricPipeline.
 The Metric feature is optional. If you don't want to use it, simply don't set up a MetricPipeline.
 
 ## Prerequisites

diff --git a/docs/user/integration/sap-cloud-logging/README.md b/docs/user/integration/sap-cloud-logging/README.md
@@ -294,21 +294,21 @@ For easier access from the Kyma dashboard, adjust the navigation under **Observa
     export DASHBOARD_URL=$(kubectl -n sap-cloud-logging-integration get secret sap-cloud-logging --template='{{index .data "dashboards-endpoint" | base64decode}}')
     ```
 
-2. Download the following configmaps containing the sample configuration:
+2. Download the following ConfigMaps containing the sample configuration:
 
     ```bash
     curl -o configmap-navigation.yaml https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/configmap-navigation.yaml
     curl -o configmap-deeplinks.yaml https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/user/integration/sap-cloud-logging/configmap-deeplinks.yaml
     ```
 
-3. Replace placeholders in the configmaps with the URL:
+3. Replace placeholders in the ConfigMaps with the URL:
 
     ```bash
     sed -e "s/{PLACEHOLDER}/$DASHBOARD_URL/" configmap-navigation.yaml
     sed -e "s/{PLACEHOLDER}/$DASHBOARD_URL/" configmap-deeplinks.yaml
     ```
 
-4. Apply the configmaps:
+4. Apply the ConfigMaps:
 
     ```bash
     kubectl apply -f configmap-navigation.yaml