]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc: Fix minor formatting, typo etc issues
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 15 Dec 2025 08:24:22 +0000 (15:24 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 15 Dec 2025 08:47:50 +0000 (15:47 +0700)
Remove formatting syntax from inside literal text in
cephadm/services/rgw.rst.
Use quotation marks similarly to other placement examples with only
parameter value quoted and not the whole parameter in
cephadm/services/rgw.rst.
Capitalize "YAML" in cephadm/services/rgw.rst.

Remove double space in the middle of a sentence in
rados/operations/erasure-code.rst.

Use double backticks consistently for default values in
radosgw/frontends.rst.
Capitalize "I/O", stylize as "OpenSSL" in radosgw/frontends.rst.

Fix typo "and object" to "an object" in radosgw/s3/bucketops.rst.

Stylize as "CentOS" in start/os-recommendations.rst.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/cephadm/services/rgw.rst
doc/rados/operations/erasure-code.rst
doc/radosgw/frontends.rst
doc/radosgw/s3/bucketops.rst
doc/start/os-recommendations.rst

index 33fde24619ba5682ba464000e0f9b996befca5a4..cc235200767f6d500b9ab3f6d1460445c589b7cb 100644 (file)
@@ -24,7 +24,7 @@ To deploy a set of ``radosgw`` daemons, with an arbitrary service name
 
 .. prompt:: bash #
 
-  ceph orch apply rgw *<name>* [--realm=*<realm-name>*] [--zone=*<zone-name>*] --placement="*<num-daemons>* [*<host1>* ...]"
+  ceph orch apply rgw <name> [--realm=<realm-name>] [--zone=<zone-name>] --placement="<num-daemons> [<host1> ...]"
 
 Trivial setup
 -------------
@@ -49,7 +49,7 @@ ports 8000 and 8001:
 
    ceph orch host label add gwhost1 rgw  # the 'rgw' label can be anything
    ceph orch host label add gwhost2 rgw
-   ceph orch apply rgw foo '--placement=label:rgw count-per-host:2' --port=8000
+   ceph orch apply rgw foo --placement='label:rgw count-per-host:2' --port=8000
 
 See also: :ref:`cephadm_co_location`.
 
@@ -248,7 +248,7 @@ For RGW services, this can be enabled by applying a spec file such as:
     zonegroup_hostnames:
     - s3.cephlab.com
 
-Then apply this yaml document:
+Then apply this YAML document:
 
 .. prompt:: bash #
 
index 0d4dcca58b5093a283f541522a92f1c513ed30ea..5d54e2660054f2ead9a6c6cee2edcaec58a70d25 100644 (file)
@@ -180,7 +180,7 @@ By default, erasure-coded pools work only with operations that
 perform full RADOS object writes, for example, RGW.
 
 Since Luminous, partial writes for an erasure-coded pool may be
-enabled with a per-pool setting. This lets RBD, CephFS, and librados  store
+enabled with a per-pool setting. This lets RBD, CephFS, and librados store
 data in an erasure-coded pool:
 
 .. prompt:: bash $
index 23a62dd9c468a99e721a40b883a04c87844837e2..f1f9c264a5d5b7e9f017f0495972dcff6b3d568d 100644 (file)
@@ -16,7 +16,7 @@ Beast
 .. versionadded:: Mimic
 
 The ``beast`` frontend uses the Boost.Beast library for HTTP parsing
-and the Boost.Asio library for asynchronous network i/o.
+and the Boost.Asio library for asynchronous network I/O.
 
 Options
 -------
@@ -73,7 +73,7 @@ Options
               reload fails, the previous context continues to be used.
 
 :Type: Integer
-:Default: 0
+:Default: ``0``
 
 ``ssl_options``
 
@@ -101,7 +101,7 @@ Options
 ``ssl_ciphers``
 
 :Description: Optional list of one or more cipher strings separated by colons.
-              The format of the string is described in openssl's ciphers(1)
+              The format of the string is described in OpenSSL's ciphers(1)
               manual.
 
 :Type: String
index 8daefe7bd8e1fc8ee74c5489511a100ec522c031..664b46ee6946968710da925df1bf4d0c6b76474e 100644 (file)
@@ -795,7 +795,7 @@ Parameters are XML encoded in the body of the request, in the following format:
 | ``LoggingType``               | String    | The type of logging. Valid values are:                                               | No       |
 |                               |           | ``Standard`` (default) all bucket operations are logged after being performed.       |          |
 |                               |           | The log record will contain all fields.                                              |          |
-|                               |           | ``Journal`` only operations that modify and object are logged.                       |          |
+|                               |           | ``Journal`` only operations that modify an object are logged.                        |          |
 |                               |           | Will record the minimum subset of fields in the log record that is needed            |          |
 |                               |           | for journaling.                                                                      |          |
 +-------------------------------+-----------+--------------------------------------------------------------------------------------+----------+
index 3b0e27962e529a741413434ca646cd3ef88f2872..b099c9be281e0947855915b8b27fb446171dd5d8 100644 (file)
@@ -51,7 +51,7 @@ non-Linux systems but these are not supported by the core Ceph effort.
 +---------------+-------------------+----------------+---------------+
 |               | Tentacle (20.2.z) | Squid (19.2.z) | Reef (18.2.z) |
 +===============+===================+================+===============+
-| Centos 9      | A                 | A              |    A          |
+| CentOS 9      | A                 | A              |    A          |
 +---------------+-------------------+----------------+---------------+
 | Debian 12     | C                 | C              |    C          |
 +---------------+-------------------+----------------+---------------+
@@ -75,7 +75,7 @@ This table shows the operating systems that support Ceph's official container im
 +---------------+-------------------+----------------+------------------+
 |               | Tentacle (20.2.z) | Squid (19.2.z) | Reef (18.2.z)    |
 +===============+===================+================+==================+
-| Centos 9      |      H            |      H         |        H         |
+| CentOS 9      |      H            |      H         |        H         |
 +---------------+-------------------+----------------+------------------+
 | Ubuntu 22.04  |      H            |      H         |        H         |
 +---------------+-------------------+----------------+------------------+