]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/radosgw: Improve formatting in bucketpolicy.rst
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 28 Apr 2025 09:44:32 +0000 (16:44 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 28 Apr 2025 13:20:48 +0000 (20:20 +0700)
Add a missing empty line before an unordered list that
caused it to be rendered as just normal text in a
single paragraph, instead of a list.

Use inline code for CLI command names and other
such identifiers.

Capitalize "s3" correctly as "S3" when it refers to
the S3 service/API.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/radosgw/bucketpolicy.rst

index 23356624a46a025ab022c4e9ae569cf03fe0e781..e85a88afc63d179278ec38572de3d815b1a941ab 100644 (file)
@@ -12,9 +12,9 @@ Creation and Removal
 ====================
 
 Bucket policies are managed through standard S3 operations rather than
-radosgw-admin.
+``radosgw-admin``.
 
-For example, one may use s3cmd to set or delete a policy thus::
+For example, one may use ``s3cmd`` to set or delete a policy thus::
 
   $ cat > examplepol
   {
@@ -101,7 +101,7 @@ Under AWS, all tenants share a single namespace. RGW gives every
 tenant its own namespace of buckets. There may be an option to enable
 an AWS-like 'flat' bucket namespace in future versions. At present, to
 access a bucket belonging to another tenant, address it as
-"tenant:bucket" in the S3 request.
+``tenant:bucket`` in the S3 request.
 
 In AWS, a bucket policy can grant access to another account, and that
 account owner can then grant access to individual users with user
@@ -113,6 +113,7 @@ a bucket grants access to all users in that account.
 Bucket policies do not yet support string interpolation.
 
 For all requests, condition keys we support are:
+
 - aws:CurrentTime
 - aws:EpochTime
 - aws:PrincipalType
@@ -122,7 +123,7 @@ For all requests, condition keys we support are:
 - aws:UserAgent
 - aws:username
 
-We support certain s3 condition keys for bucket and object requests.
+We support certain S3 condition keys for bucket and object requests.
 
 *Support for the following bucket-related operations was added in the Mimic
 release of Ceph.*