From 34ff1ddca1d228bb785ec04f3aef6ccfdccdc5de Mon Sep 17 00:00:00 2001 From: Jason Dillaman Date: Tue, 8 Aug 2017 11:53:42 -0400 Subject: [PATCH] doc: re-ordered rbd table of contents Signed-off-by: Jason Dillaman --- doc/index.rst | 4 ++-- doc/rados/index.rst | 2 +- doc/rbd/api/index.rst | 8 ++++++++ doc/rbd/{ => api}/librbdpy.rst | 0 doc/rbd/{rbd.rst => index.rst} | 20 +++++++++++--------- doc/rbd/man/index.rst | 16 ++++++++++++++++ doc/rbd/rbd-config-ref.rst | 2 +- doc/start/quick-rbd.rst | 2 +- 8 files changed, 40 insertions(+), 14 deletions(-) create mode 100644 doc/rbd/api/index.rst rename doc/rbd/{ => api}/librbdpy.rst (100%) rename doc/rbd/{rbd.rst => index.rst} (87%) create mode 100644 doc/rbd/man/index.rst diff --git a/doc/index.rst b/doc/index.rst index d070c472618..253e2a4f549 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -82,7 +82,7 @@ about Ceph, see our `Architecture`_ section. .. _Ceph Object Store: radosgw -.. _Ceph Block Device: rbd/rbd +.. _Ceph Block Device: rbd .. _Ceph Filesystem: cephfs .. _Getting Started: start .. _Architecture: architecture @@ -96,7 +96,7 @@ about Ceph, see our `Architecture`_ section. install/index rados/index cephfs/index - rbd/rbd + rbd/index radosgw/index mgr/index api/index diff --git a/doc/rados/index.rst b/doc/rados/index.rst index 9ff756c97d3..929bb7efacb 100644 --- a/doc/rados/index.rst +++ b/doc/rados/index.rst @@ -70,7 +70,7 @@ the Ceph Storage Cluster. -.. _Ceph Block Devices: ../rbd/rbd +.. _Ceph Block Devices: ../rbd/ .. _Ceph Filesystem: ../cephfs/ .. _Ceph Object Storage: ../radosgw/ .. _Deployment: ../rados/deployment/ diff --git a/doc/rbd/api/index.rst b/doc/rbd/api/index.rst new file mode 100644 index 00000000000..71f680933b7 --- /dev/null +++ b/doc/rbd/api/index.rst @@ -0,0 +1,8 @@ +======================== + Ceph Block Device APIs +======================== + +.. toctree:: + :maxdepth: 2 + + librados (Python) diff --git a/doc/rbd/librbdpy.rst b/doc/rbd/api/librbdpy.rst similarity index 100% rename from doc/rbd/librbdpy.rst rename to doc/rbd/api/librbdpy.rst diff --git a/doc/rbd/rbd.rst b/doc/rbd/index.rst similarity index 87% rename from doc/rbd/rbd.rst rename to doc/rbd/index.rst index e27e8c64756..5d9d433ce1b 100644 --- a/doc/rbd/rbd.rst +++ b/doc/rbd/index.rst @@ -50,16 +50,18 @@ devices simultaneously. Cache Settings OpenStack CloudStack - Manpage rbd <../../man/8/rbd> - Manpage rbd-fuse <../../man/8/rbd-fuse> - Manpage rbd-nbd <../../man/8/rbd-nbd> - Manpage ceph-rbdnamer <../../man/8/ceph-rbdnamer> RBD Replay - Manpage rbd-replay-prep <../../man/8/rbd-replay-prep> - Manpage rbd-replay <../../man/8/rbd-replay> - Manpage rbd-replay-many <../../man/8/rbd-replay-many> - Manpage rbdmap <../../man/8/rbdmap> - librbd + +.. toctree:: + :maxdepth: 2 + + Manpages + +.. toctree:: + :maxdepth: 2 + + APIs + diff --git a/doc/rbd/man/index.rst b/doc/rbd/man/index.rst new file mode 100644 index 00000000000..33a192a7722 --- /dev/null +++ b/doc/rbd/man/index.rst @@ -0,0 +1,16 @@ +============================ + Ceph Block Device Manpages +============================ + +.. toctree:: + :maxdepth: 1 + + rbd <../../man/8/rbd> + rbd-fuse <../../man/8/rbd-fuse> + rbd-nbd <../../man/8/rbd-nbd> + rbd-ggate <../../man/8/rbd-ggate> + 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/rbd-config-ref.rst b/doc/rbd/rbd-config-ref.rst index 6ce2fdc2c2c..db942f88c78 100644 --- a/doc/rbd/rbd-config-ref.rst +++ b/doc/rbd/rbd-config-ref.rst @@ -98,7 +98,7 @@ section of your configuration file. The settings include: :Required: No :Default: ``true`` -.. _Block Device: ../../rbd/rbd/ +.. _Block Device: ../../rbd Read-ahead Settings diff --git a/doc/start/quick-rbd.rst b/doc/start/quick-rbd.rst index debc0fc206f..5534fa9e572 100644 --- a/doc/start/quick-rbd.rst +++ b/doc/start/quick-rbd.rst @@ -89,7 +89,7 @@ See `block devices`_ for additional details. .. _Storage Cluster Quick Start: ../quick-ceph-deploy .. _create a pool: ../../rados/operations/pools/#create-a-pool -.. _block devices: ../../rbd/rbd +.. _block devices: ../../rbd .. _FAQ: http://wiki.ceph.com/How_Can_I_Give_Ceph_a_Try .. _OS Recommendations: ../os-recommendations .. _rbdmap manpage: ../../man/8/rbdmap -- 2.47.3