From 2c6418e17ac6580b4726e08c70132b1c540f92c1 Mon Sep 17 00:00:00 2001
From: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
Date: Thu, 4 Apr 2024 10:14:06 +0200
Subject: [PATCH] docs: fix typo and improve explanation on internal resources

---
 docs/content/migration/v2-to-v3.md             | 4 ++--
 docs/content/observability/access-logs.md      | 4 ++--
 docs/content/observability/metrics/overview.md | 2 +-
 docs/content/observability/tracing/overview.md | 4 ++--
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/content/migration/v2-to-v3.md b/docs/content/migration/v2-to-v3.md
index 6fb88c0e7..61a60d990 100644
--- a/docs/content/migration/v2-to-v3.md
+++ b/docs/content/migration/v2-to-v3.md
@@ -724,7 +724,7 @@ Here are two possible transition strategies:
 
 Please check the [OpenTelemetry Tracing provider documention](../observability/tracing/opentelemetry.md) for more information.
 
-#### Internal Resources Observability (AccessLogs, Metrics and Tracing)
+#### Internal Resources Observability
 
 In v3, observability for internal routers or services (e.g.: `ping@internal`) is disabled by default.
 To enable it one should use the new `addInternals` option for AccessLogs, Metrics or Tracing.
@@ -732,4 +732,4 @@ Please take a look at the observability documentation for more information:
 
 - [AccessLogs](../observability/access-logs.md#addinternals)
 - [Metrics](../observability/metrics/overview.md#addinternals)
-- [AccessLogs](../observability/tracing/overview.md#addinternals)
+- [Tracing](../observability/tracing/overview.md#addinternals)
diff --git a/docs/content/observability/access-logs.md b/docs/content/observability/access-logs.md
index beb114db1..2105cc030 100644
--- a/docs/content/observability/access-logs.md
+++ b/docs/content/observability/access-logs.md
@@ -30,7 +30,7 @@ accessLog: {}
 
 _Optional, Default="false"_
 
-Enables accessLogs for internal resources.
+Enables accessLogs for internal resources (e.g.: `ping@internal`).
 
 ```yaml tab="File (YAML)"
 accesslog:
@@ -187,7 +187,7 @@ accessLog:
 
   [accessLog.fields]
     defaultMode = "keep"
-    
+
     [accessLog.fields.names]
       "ClientUsername" = "drop"
 
diff --git a/docs/content/observability/metrics/overview.md b/docs/content/observability/metrics/overview.md
index 082d4aed0..a49c5053c 100644
--- a/docs/content/observability/metrics/overview.md
+++ b/docs/content/observability/metrics/overview.md
@@ -21,7 +21,7 @@ and [Kubernetes](https://grafana.com/grafana/dashboards/17347) deployments.
 
 _Optional, Default="false"_
 
-Enables metrics for internal resources.
+Enables metrics for internal resources (e.g.: `ping@internals`).
 
 ```yaml tab="File (YAML)"
 metrics:
diff --git a/docs/content/observability/tracing/overview.md b/docs/content/observability/tracing/overview.md
index 72dd20cd6..e81f63edf 100644
--- a/docs/content/observability/tracing/overview.md
+++ b/docs/content/observability/tracing/overview.md
@@ -36,7 +36,7 @@ tracing: {}
 
 _Optional, Default="false"_
 
-Enables tracing for internal resources.
+Enables tracing for internal resources (e.g.: `ping@internal`).
 
 ```yaml tab="File (YAML)"
 tracing:
@@ -159,4 +159,4 @@ tracing:
 
 ```bash tab="CLI"
 --tracing.capturedResponseHeaders[0]=X-CustomHeader
-```
\ No newline at end of file
+```