From 1c319447f8f51b281638e93aaba39b777a0d9b20 Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Mon, 15 Dec 2025 15:24:22 +0700 Subject: [PATCH] doc: Fix minor formatting, typo etc issues 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 | 6 +++--- doc/rados/operations/erasure-code.rst | 2 +- doc/radosgw/frontends.rst | 6 +++--- doc/radosgw/s3/bucketops.rst | 2 +- doc/start/os-recommendations.rst | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/cephadm/services/rgw.rst b/doc/cephadm/services/rgw.rst index 33fde24619b..cc235200767 100644 --- a/doc/cephadm/services/rgw.rst +++ b/doc/cephadm/services/rgw.rst @@ -24,7 +24,7 @@ To deploy a set of ``radosgw`` daemons, with an arbitrary service name .. prompt:: bash # - ceph orch apply rgw ** [--realm=**] [--zone=**] --placement="** [** ...]" + ceph orch apply rgw [--realm=] [--zone=] --placement=" [ ...]" 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 # diff --git a/doc/rados/operations/erasure-code.rst b/doc/rados/operations/erasure-code.rst index 0d4dcca58b5..5d54e266005 100644 --- a/doc/rados/operations/erasure-code.rst +++ b/doc/rados/operations/erasure-code.rst @@ -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 $ diff --git a/doc/radosgw/frontends.rst b/doc/radosgw/frontends.rst index 23a62dd9c46..f1f9c264a5d 100644 --- a/doc/radosgw/frontends.rst +++ b/doc/radosgw/frontends.rst @@ -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 diff --git a/doc/radosgw/s3/bucketops.rst b/doc/radosgw/s3/bucketops.rst index 8daefe7bd8e..664b46ee694 100644 --- a/doc/radosgw/s3/bucketops.rst +++ b/doc/radosgw/s3/bucketops.rst @@ -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. | | +-------------------------------+-----------+--------------------------------------------------------------------------------------+----------+ diff --git a/doc/start/os-recommendations.rst b/doc/start/os-recommendations.rst index 3b0e27962e5..b099c9be281 100644 --- a/doc/start/os-recommendations.rst +++ b/doc/start/os-recommendations.rst @@ -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 | +---------------+-------------------+----------------+------------------+ -- 2.47.3