New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Fixing the broken hyperlinks by pointing to correct documentation. #11617
Conversation
@@ -176,7 +176,7 @@ Save the uuid of the secret for configuring ``nova-compute`` later. | |||
However from a platform consistency perspective, it's better to keep the | |||
same UUID. | |||
|
|||
.. _cephx authentication: ../../rados/operations/authentication | |||
.. _cephx authentication: ../../rados/operations/user-management/#add-a-user |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
probably we can point this reference to ../../rados/configuration/auth-config-ref#enabling-disabling-cephx instead? which i think is more relevant?
@@ -817,7 +817,7 @@ there is a unified namespace between the two regions. | |||
|
|||
.. _CRUSH Map: ../../rados/operations/crush-map | |||
.. _Install Ceph Object Gateway: ../../install/install-ceph-gateway | |||
.. _Cephx Administration: ../../rados/operations/authentication/#cephx-administration | |||
.. _Cephx Administration: ../../rados/operations/user-management/#managing-users |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we used to have a paragraph referencing this section
When accessing the Ceph Storage Cluster, each instance of a Ceph Object Gateway
must provide the Ceph Storage Cluster with a user name and key. We recommend
setting up at least one user name and key for each zone. See `Cephx
Administration`_ for a discussion on adding keyrings and keys.
this paragraph is now a part of "Create a Keyring", and the link was removed. maybe we can remove the reference as well?
@@ -742,8 +742,8 @@ Under those directories, the keyring should be in a file named ``keyring``. | |||
|
|||
.. _Monitor Config Reference: ../../rados/configuration/mon-config-ref | |||
.. _Joao's blog post: http://ceph.com/dev-notes/cephs-new-monitor-changes | |||
.. _Ceph Authentication: ../../rados/operations/authentication/ | |||
.. _Ceph Authentication - Backward Compatibility: ../../rados/operations/authentication/#backward-compatibility | |||
.. _Ceph Authentication: ../../rados/operations/user-management/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might want to update the place referencing this section as well to reflect the updated name of the "Authentication" section. like
diff --git a/doc/install/upgrading-ceph.rst b/doc/install/upgrading-ceph.rst
index 3ff63e2..b7f8889 100644
--- a/doc/install/upgrading-ceph.rst
+++ b/doc/install/upgrading-ceph.rst
@@ -174,8 +174,8 @@ daemon cannot participate in the new protocol). We recommend not waiting for an
extended period of time between ``ceph-mon`` upgrades. See `Upgrading
Monitors`_ for details.
-.. note:: See the `Authentication`_ section and the
- `Ceph Authentication - Backward Compatibility`_ for additional information
+.. note:: See the `User Management`_ section and the
+ `User Management - Backward Compatibility`_ for additional information
on authentication backward compatibility settings for Bobtail.
Once you complete the upgrade of your monitors from Argonaut to
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Authentication
_ , refers to the section in the same page, which points to the authentication for Bobtail version.
.. _Authentication: ../../rados/operations/user-management/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might want to update the place referencing this section as well to reflect the updated section name of the "Authentication" section.
@@ -44,4 +44,4 @@ Ensure you use the ID (e.g., ``admin``, not ``client.admin``). You can pass any | |||
See `Authentication`_ for details. | |||
|
|||
|
|||
.. _Authentication: ../../rados/operations/authentication/ | |||
.. _Authentication: ../../rados/operations/user-management/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might want to update the place referencing this section as well to reflect the updated section name of the "Authentication" section.
Signed-off-by: umullangi@walmartlabs.com
Kefu Chai, I have incorporated your comments. Can you please review the changes ? |
lgtm. |
Signed-off-by: umullangi@walmartlabs.com