]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commit
doc/radosgw: Improve and more consistent formatting 62909/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 18 Apr 2025 07:43:27 +0000 (14:43 +0700)
committerZac Dover <zac.dover@proton.me>
Fri, 6 Jun 2025 01:18:03 +0000 (11:18 +1000)
commitb72f917fce1e5d8b612da4caa3f3d57831dbd93c
tree7753bdc027e1e7c40fe94882d2fa40a2eb12b91d
parenta6e91c686e3b990209950b75140aa59598787535
doc/radosgw: Improve and more consistent formatting

Use inline code formatting consistently for command
line switches, data, hostnames, etc.
Correctly indent text and child lists in list items.
Remove a mid-sentence double spaces.
Capitalize "RGW" and "API" in text.
Remove unordered lists that are just regular text
everywhere else.
Use correct prompt # instead of $ for privileged
commands.
Use line continuation for multi-line example commands
instead of render them incorrectly as separate
single-line commands.
Use Title Case in few section header text that
missed it.
multisite.rst: Don't repeat "(RGW)" after "RADOS
Gateway" beyond the first instance in the same
paragraph.
multisite.rst: Change one "multisite" to "multi-site"
because all other instances use this spelling (EXCEPT
the title of the document??).
multisite.rst: Fix indentation of continuation lines in
prompted example commands.
Use pre-formatted block, as seen elsewhere in docs,
instead of strange unordered list plus inline code for
syntax example.
Add space before backslash for multi-line command
continuation.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
(cherry picked from commit a74f2e5f008691668884ebe3ed50eda6a9e0966e)
doc/radosgw/admin.rst
doc/radosgw/cloud-sync-module.rst
doc/radosgw/metrics.rst
doc/radosgw/multisite-sync-policy.rst
doc/radosgw/multisite.rst