From: Zac Dover <zac.dover@proton.me>
Date: Thu, 14 Mar 2024 06:29:09 +0000 (+1000)
Subject: doc/glossary: add "librados" entry
X-Git-Tag: testing/wip-pdonnell-testing-20240430.123648-reef-debug~136^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1acafaa7d498c66ce0266040b246763fe688eca2;p=ceph-ci.git

doc/glossary: add "librados" entry

Add a "librados" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 2a93a8e837a42559f8a81c6fd9274b24f4fdf7f6)
---

diff --git a/doc/glossary.rst b/doc/glossary.rst
index 8f956b1acb0..978eae0c2a6 100644
--- a/doc/glossary.rst
+++ b/doc/glossary.rst
@@ -269,6 +269,13 @@
         Hybrid OSD  
                 Refers to an OSD that has both HDD and SSD drives.
 
+        librados
+                An API that can be used to create a custom interface to a Ceph
+                storage cluster. ``librados`` makes it possible to interact
+                with Ceph Monitors and with OSDs. See :ref:`Introduction to
+                librados <librados-intro>`. See :ref:`librados (Python)
+                <librados-python>`.
+
 	LVM tags
                 **L**\ogical **V**\olume **M**\anager tags. Extensible metadata
                 for LVM volumes and groups. They are used to store
diff --git a/doc/rados/api/librados-intro.rst b/doc/rados/api/librados-intro.rst
index 5174188b4c5..b863efc9e68 100644
--- a/doc/rados/api/librados-intro.rst
+++ b/doc/rados/api/librados-intro.rst
@@ -1,3 +1,5 @@
+.. _librados-intro:
+
 ==========================
  Introduction to librados
 ==========================
diff --git a/doc/rados/api/python.rst b/doc/rados/api/python.rst
index 346653a3d2e..60bdfa4da06 100644
--- a/doc/rados/api/python.rst
+++ b/doc/rados/api/python.rst
@@ -1,3 +1,5 @@
+.. _librados-python:
+
 ===================
  Librados (Python)
 ===================