From 0277e2f63938db8a8eae52c356bcbd3736dfe5d1 Mon Sep 17 00:00:00 2001 From: Jason Dillaman Date: Fri, 19 Jul 2019 09:44:44 -0400 Subject: [PATCH] doc/rbd: restructure into operations and integrations This avoids the long table of contents list of intermingled subjects. Signed-off-by: Jason Dillaman --- doc/rbd/index.rst | 27 +++++++++++++-------------- doc/rbd/man/index.rst | 2 +- doc/rbd/rados-rbd-cmds.rst | 6 +++--- doc/rbd/rbd-integrations.rst | 13 +++++++++++++ doc/rbd/rbd-operations.rst | 12 ++++++++++++ 5 files changed, 42 insertions(+), 18 deletions(-) create mode 100644 doc/rbd/rbd-integrations.rst create mode 100644 doc/rbd/rbd-operations.rst diff --git a/doc/rbd/index.rst b/doc/rbd/index.rst index a0ec19693d5..a350dc789c1 100644 --- a/doc/rbd/index.rst +++ b/doc/rbd/index.rst @@ -39,20 +39,19 @@ to operate the :ref:`Ceph RADOS Gateway `, the Ceph cluster. .. toctree:: - :maxdepth: 1 - - Commands - Kernel Modules - Snapshots - Mirroring - Persistent Cache - LIO iSCSI Gateway - QEMU - libvirt - librbd Settings - OpenStack - CloudStack - RBD Replay + :maxdepth: 1 + + Basic Commands + +.. toctree:: + :maxdepth: 2 + + Operations + +.. toctree:: + :maxdepth: 2 + + Integrations .. toctree:: :maxdepth: 2 diff --git a/doc/rbd/man/index.rst b/doc/rbd/man/index.rst index 33a192a7722..110273acc83 100644 --- a/doc/rbd/man/index.rst +++ b/doc/rbd/man/index.rst @@ -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> diff --git a/doc/rbd/rados-rbd-cmds.rst b/doc/rbd/rados-rbd-cmds.rst index d0e466f239a..4b2dd859cb5 100644 --- a/doc/rbd/rados-rbd-cmds.rst +++ b/doc/rbd/rados-rbd-cmds.rst @@ -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 index 00000000000..2eb4cb7ad05 --- /dev/null +++ b/doc/rbd/rbd-integrations.rst @@ -0,0 +1,13 @@ +========================================= + Ceph Block Device 3rd Party Integration +========================================= + +.. toctree:: + :maxdepth: 1 + + Kernel Modules + QEMU + libvirt + OpenStack + CloudStack + LIO iSCSI Gateway diff --git a/doc/rbd/rbd-operations.rst b/doc/rbd/rbd-operations.rst new file mode 100644 index 00000000000..7a0e91eea43 --- /dev/null +++ b/doc/rbd/rbd-operations.rst @@ -0,0 +1,12 @@ +============================== + Ceph Block Device Operations +============================== + +.. toctree:: + :maxdepth: 1 + + Snapshots + Mirroring + Persistent Cache + Config Settings (librbd) + RBD Replay -- 2.39.5