]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/rbd: restructure into operations and integrations
authorJason Dillaman <dillaman@redhat.com>
Fri, 19 Jul 2019 13:44:44 +0000 (09:44 -0400)
committerJason Dillaman <dillaman@redhat.com>
Fri, 19 Jul 2019 13:47:52 +0000 (09:47 -0400)
This avoids the long table of contents list of intermingled subjects.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
doc/rbd/index.rst
doc/rbd/man/index.rst
doc/rbd/rados-rbd-cmds.rst
doc/rbd/rbd-integrations.rst [new file with mode: 0644]
doc/rbd/rbd-operations.rst [new file with mode: 0644]

index a0ec19693d58f5e629d2d247450a3968822b50f6..a350dc789c152ce97a93bd9315382f46aa7aecfb 100644 (file)
@@ -39,20 +39,19 @@ to operate the :ref:`Ceph RADOS Gateway <object-gateway>`, the
    Ceph cluster.
 
 .. toctree::
-       :maxdepth: 1
-
-       Commands <rados-rbd-cmds>
-       Kernel Modules <rbd-ko>
-       Snapshots<rbd-snapshot>
-       Mirroring <rbd-mirroring>
-        Persistent Cache <rbd-persistent-cache>
-       LIO iSCSI Gateway <iscsi-overview>
-       QEMU <qemu-rbd>
-       libvirt <libvirt>
-       librbd Settings <rbd-config-ref/>
-       OpenStack <rbd-openstack>
-       CloudStack <rbd-cloudstack>
-       RBD Replay <rbd-replay>
+        :maxdepth: 1
+
+       Basic Commands <rados-rbd-cmds>
+
+.. toctree::
+        :maxdepth: 2
+
+        Operations <rbd-operations>
+
+.. toctree::
+       :maxdepth: 2
+
+        Integrations <rbd-integrations>
 
 .. toctree::
        :maxdepth: 2
index 33a192a7722c6c3526c27340510f02a8a65d85f2..110273acc832ea42e05ee2295eb8a98e5bbd63cc 100644 (file)
@@ -9,8 +9,8 @@
    rbd-fuse <../../man/8/rbd-fuse>
    rbd-nbd <../../man/8/rbd-nbd>
    rbd-ggate <../../man/8/rbd-ggate>
+   rbd-map <../../man/8/rbdmap>
    ceph-rbdnamer <../../man/8/ceph-rbdnamer>
    rbd-replay-prep <../../man/8/rbd-replay-prep>
    rbd-replay <../../man/8/rbd-replay>
    rbd-replay-many <../../man/8/rbd-replay-many>
-   rbd-map <../../man/8/rbdmap>
index d0e466f239a94b0c40fbf946463e4f881f46a4ca..4b2dd859cb5ba986ddc19427abe3b4d17fadb90f 100644 (file)
@@ -1,6 +1,6 @@
-=======================
- Block Device Commands
-=======================
+=============================
+ Basic Block Device Commands
+=============================
 
 .. index:: Ceph Block Device; image management
 
diff --git a/doc/rbd/rbd-integrations.rst b/doc/rbd/rbd-integrations.rst
new file mode 100644 (file)
index 0000000..2eb4cb7
--- /dev/null
@@ -0,0 +1,13 @@
+=========================================
+ Ceph Block Device 3rd Party Integration
+=========================================
+
+.. toctree::
+   :maxdepth: 1
+
+   Kernel Modules <rbd-ko>
+   QEMU <qemu-rbd>
+   libvirt <libvirt>
+   OpenStack <rbd-openstack>
+   CloudStack <rbd-cloudstack>
+   LIO iSCSI Gateway <iscsi-overview>
diff --git a/doc/rbd/rbd-operations.rst b/doc/rbd/rbd-operations.rst
new file mode 100644 (file)
index 0000000..7a0e91e
--- /dev/null
@@ -0,0 +1,12 @@
+==============================
+ Ceph Block Device Operations
+==============================
+
+.. toctree::
+   :maxdepth: 1
+
+   Snapshots<rbd-snapshot>
+   Mirroring <rbd-mirroring>
+   Persistent Cache <rbd-persistent-cache>
+   Config Settings (librbd) <rbd-config-ref/>
+   RBD Replay <rbd-replay>