From: Zac Dover <zac.dover@proton.me>
Date: Thu, 29 Feb 2024 08:08:10 +0000 (+1000)
Subject: doc/glossary: improve "MDS" entry
X-Git-Tag: v20.0.0~2505^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=2c6983d8b4e841f2bfbc4e4f82bb0e41e10aec7e;p=ceph.git

doc/glossary: improve "MDS" entry

Improve the entry for "MDS" in doc/glossary.rst by linking to the
"ceph-mds" man page and mentioning the relationship between clients and
MDS (or MDSes).

Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/doc/glossary.rst b/doc/glossary.rst
index 8f1c5659756d1..262b89598c50b 100644
--- a/doc/glossary.rst
+++ b/doc/glossary.rst
@@ -263,11 +263,18 @@
                 Ceph-specific information about devices and its relationship
                 with OSDs.
 
-	:ref:`MDS<cephfs_add_remote_mds>`
+	MDS
                 The Ceph **M**\eta\ **D**\ata **S**\erver daemon. Also referred
                 to as "ceph-mds". The Ceph metadata server daemon must be
                 running in any Ceph cluster that runs the CephFS file system.
-                The MDS stores all filesystem metadata. 
+                The MDS stores all filesystem metadata. :term:`Client`\s work
+                together with either a single MDS or a group of MDSes to
+                maintain a distributed metadata cache that is required by
+                CephFS.
+
+                See :ref:`Deploying Metadata Servers<cephfs_add_remote_mds>`.
+
+                See the :ref:`ceph-mds man page<ceph_mds_man>`.
 
 	MGR
                 The Ceph manager software, which collects all the state from
diff --git a/doc/man/8/ceph-mds.rst b/doc/man/8/ceph-mds.rst
index fd8fc800eca31..c68d3d110afad 100644
--- a/doc/man/8/ceph-mds.rst
+++ b/doc/man/8/ceph-mds.rst
@@ -1,5 +1,7 @@
 :orphan:
 
+.. _ceph_mds_man:
+
 =========================================
  ceph-mds -- ceph metadata server daemon
 =========================================