From: Zac Dover <zac.dover@proton.me>
Date: Wed, 27 Dec 2023 04:28:51 +0000 (+1000)
Subject: doc/radosgw: admin.rst - edit "Create a Subuser"
X-Git-Tag: v18.2.4~390^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F55020%2Fhead;p=ceph.git

doc/radosgw: admin.rst - edit "Create a Subuser"

Edit the section "Create a Subuser" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 3c7a6c41df540f935b0b0b2c4fdc7375327a7662)
---

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index e9d5697acc27..8f25add73dfb 100644
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -93,17 +93,23 @@ The creation of a user entails the creation of an ``access_key`` and a
 Create a Subuser
 ----------------
 
-To create a subuser (Swift interface) for the user, you must specify the user ID
-(``--uid={username}``), a subuser ID and the access level for the subuser. ::
+To create a subuser (a user of the Swift interface) for the user, specify the
+user ID (``--uid={username}``), a subuser ID, and the subuser's access level:
 
-  radosgw-admin subuser create --uid={uid} --subuser={uid} --access=[ read | write | readwrite | full ]
+.. prompt:: bash
 
-For example::
+   radosgw-admin subuser create --uid={uid} --subuser={uid} --access=[ read | write | readwrite | full ]
+
+For example:
+
+.. prompt:: bash
 
-  radosgw-admin subuser create --uid=johndoe --subuser=johndoe:swift --access=full
+   radosgw-admin subuser create --uid=johndoe --subuser=johndoe:swift --access=full
 
 
-.. note:: ``full`` is not ``readwrite``, as it also includes the access control policy.
+.. note:: ``full`` is not the same as ``readwrite``. The ``full`` access level
+   includes ``read`` and ``write``, but it also includes the access control
+   policy.
 
 .. code-block:: javascript