From: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
Date: Mon, 4 Aug 2025 06:06:38 +0000 (+0700)
Subject: doc/cephadm: Small improvements in services/tracing.rst
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=9b534846c65ac4967f7ef52dbfceeb6e5bc9ad2d;p=ceph.git

doc/cephadm: Small improvements in services/tracing.rst

Use ref instead of a full URL link and add label for it in
doc/jaegertracing/index.rst.

Capitalize "Ceph", "Jaeger", "ElasticSearch" consistently.
Start sentences with capital case consistently.
Fix a typo.

Wrap lines a bit before column 80.

Use an ordered list instead of hardcoding list numbers in separate
paragraphs.

Don't use ordered list for items that do not both fit under the text
paragraph introducing the list.
Rewrite the sentences to be more consistent and hopefully more correct.

Add articles that I believe should be there, also for consistency with
the previous paragraph.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
---

diff --git a/doc/cephadm/services/tracing.rst b/doc/cephadm/services/tracing.rst
index e96d601d26d7c..5f7d2dc3d5a53 100644
--- a/doc/cephadm/services/tracing.rst
+++ b/doc/cephadm/services/tracing.rst
@@ -8,38 +8,35 @@ Tracing Services
 Jaeger Tracing
 ==============
 
-Ceph uses Jaeger as the tracing backend. in order to use tracing, we need to deploy those services.
+Ceph uses Jaeger as its tracing backend. In order to use tracing, we need to
+deploy those services.
 
-Further details on tracing in ceph:
-
-`Ceph Tracing documentation <https://docs.ceph.com/en/latest/jaegertracing/#jaeger-distributed-tracing/>`_
+For further details on tracing in Ceph, see
+:ref:`Ceph tracing documentation <jaegertracing>`.
 
 Deployment
 ==========
 
-Jaeger services consist of 3 services:
-
-1. Jaeger Agent
-
-2. Jaeger Collector
-
-3. Jaeger Query
-
-Jaeger requires a database for the traces. we use ElasticSearch (version 6) by default.
-
+Jaeger tracing consists of 3 services:
 
-To deploy jaeger tracing service, when not using your own ElasticSearch:
+#. Jaeger Agent
+#. Jaeger Collector
+#. Jaeger Query
 
-#. Deploy jaeger services, with a new elasticsearch container:
+Jaeger requires a database for the traces. We use ElasticSearch (version 6)
+by default.
 
-    .. prompt:: bash #
+To deploy Jaeger services when not using your own ElasticSearch (deploys
+all 3 services with a new ElasticSearch container):
 
-        ceph orch apply jaeger
+.. prompt:: bash #
 
+   ceph orch apply jaeger
 
-#. Deploy jaeger services, with existing elasticsearch cluster and existing jaeger query (deploy agents and collectors):
+To deploy Jaeger services with an existing ElasticSearch cluster and
+an existing Jaeger query (deploys agents and collectors only):
 
-     .. prompt:: bash #
+.. prompt:: bash #
 
-        ceph orch apply jaeger --without-query --es_nodes=ip:port,..
+   ceph orch apply jaeger --without-query --es_nodes=ip:port,..
 
diff --git a/doc/jaegertracing/index.rst b/doc/jaegertracing/index.rst
index 43a145722f8ef..4e2c2415a873e 100644
--- a/doc/jaegertracing/index.rst
+++ b/doc/jaegertracing/index.rst
@@ -1,3 +1,5 @@
+.. _jaegertracing:
+
 JAEGER- DISTRIBUTED TRACING
 ===========================