From 715c003f8509beae27a153147fc7e5f2c0e7d8c9 Mon Sep 17 00:00:00 2001 From: James McClune Date: Fri, 4 Jan 2019 16:32:21 -0500 Subject: [PATCH] doc: updated Ceph documentation links Fixes include: - Updating Doxygen link for reference (http://docs.ceph.com/docs/master/dev/documenting/) - Adding :ref: label for User Management page (http://docs.ceph.com/docs/master/rados/operations/user-management/) - Update User Management link for reference (http://docs.ceph.com/docs/master/rbd/rbd-snapshot/) Fixes: https://tracker.ceph.com/issues/37793 Signed-off-by: James McClune (cherry picked from commit 7ff2f215a3d051c4ef226bfdc81184d89520e152) --- doc/dev/documenting.rst | 2 +- doc/rados/operations/user-management.rst | 2 ++ doc/rbd/rbd-snapshot.rst | 3 +-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/dev/documenting.rst b/doc/dev/documenting.rst index 5ed6f7fc691f5..cb2f0a5fd0a19 100644 --- a/doc/dev/documenting.rst +++ b/doc/dev/documenting.rst @@ -30,7 +30,7 @@ Code Documentation C and C++ can be documented with Doxygen_, using the subset of Doxygen markup supported by Breathe_. -.. _Doxygen: http://www.stack.nl/~dimitri/doxygen/ +.. _Doxygen: http://www.doxygen.nl/ .. _Breathe: https://github.com/michaeljones/breathe The general format for function documentation is:: diff --git a/doc/rados/operations/user-management.rst b/doc/rados/operations/user-management.rst index 4bf525103e7c1..11c64f4fff1e2 100644 --- a/doc/rados/operations/user-management.rst +++ b/doc/rados/operations/user-management.rst @@ -1,3 +1,5 @@ +.. _user-management: + ================= User Management ================= diff --git a/doc/rbd/rbd-snapshot.rst b/doc/rbd/rbd-snapshot.rst index 1cb6cb309ccc4..4ae9388c2e546 100644 --- a/doc/rbd/rbd-snapshot.rst +++ b/doc/rbd/rbd-snapshot.rst @@ -36,7 +36,7 @@ Cephx Notes When `cephx`_ is enabled (it is by default), you must specify a user name or ID and a path to the keyring containing the corresponding key for the user. See -`User Management`_ for details. You may also add the ``CEPH_ARGS`` environment +:ref:`User Management ` for details. You may also add the ``CEPH_ARGS`` environment variable to avoid re-entry of the following parameters. :: rbd --id {user-ID} --keyring=/path/to/secret [commands] @@ -301,7 +301,6 @@ For example:: .. _cephx: ../../rados/configuration/auth-config-ref/ -.. _User Management: ../../operations/user-management .. _QEMU: ../qemu-rbd/ .. _OpenStack: ../rbd-openstack/ .. _CloudStack: ../rbd-cloudstack/ -- 2.39.5