]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/releases/octopus.rst: formatting tweaks
authorKefu Chai <kchai@redhat.com>
Sun, 15 Mar 2020 15:39:22 +0000 (23:39 +0800)
committerKefu Chai <kchai@redhat.com>
Sun, 15 Mar 2020 18:00:46 +0000 (02:00 +0800)
* use console lexer for highlighting command lines
  otherwise they will be rendered as python code
* use bold font instead italic in subsection headers,
  they look more formal this way
* fix a typo: delineated

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/releases/octopus.rst

index beb0eb4f01f5c8b22c9c57a83a7b989f91df6dd9..0cb3bed7a1473a349ae476065ba2e51ddd529b47 100644 (file)
@@ -110,8 +110,8 @@ RADOS
     scalable fashion.
 
 
-*RBD* block storage
-~~~~~~~~~~~~~~~~~~~
+**RBD** block storage
+~~~~~~~~~~~~~~~~~~~~~
   
   * Clone operations now preserve the sparseness of the underlying RBD image.
   * The trash feature has been improved to (optionally) automatically
@@ -121,15 +121,15 @@ RADOS
   * Caching has been improved to be more efficient and performant.
 
 
-*RGW* object storage
-~~~~~~~~~~~~~~~~~~~~
+**RGW** object storage
+~~~~~~~~~~~~~~~~~~~~~~
   
   * Multi-site replication can now be managed on a per-bucket basis (EXPERIMENTAL).
   * WORM?
   * bucket tagging?
 
-*CephFS* distributed file system
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+**CephFS** distributed file system
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   
   * Inline data support in CephFS has been deprecated and will likely be
     removed in a future release.
@@ -155,6 +155,8 @@ Notes
 Instructions
 ~~~~~~~~~~~~
 
+.. highlight:: console
+
 #. Make sure your cluster is stable and healthy (no down or
    recovering OSDs).  (Optional, but recommended.)
 
@@ -344,8 +346,6 @@ Upgrade compatibility notes
   as the native python3. see the `announcement`_
   for more details on the background of this change.
 
-.. _announcement: https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/message/EGUMKAIMPK2UD5VSHXM53BH2MBDGDWMO/
-
 * librbd now uses a write-around cache policy be default,
   replacing the previous write-back cache policy default.
   This cache policy allows librbd to immediately complete
@@ -571,8 +571,8 @@ Upgrade compatibility notes
   has been removed in favor of the ``osd_mclock_scheduler*`` family
   of options.
 
-* The config subsystem now searches dot ('.') delineated prefixes for
-  options.  That means for an entity like ``client.foo.bar``, it's
+* The config subsystem now searches dot ('.') delimited prefixes for
+  options.  That means for an entity like ``client.foo.bar``, its
   overall configuration will be a combination of the global options,
   ``client``, ``client.foo``, and ``client.foo.bar``.  Previously,
   only global, ``client``, and ``client.foo.bar`` options would apply.
@@ -580,3 +580,5 @@ Upgrade compatibility notes
   ``.`` in their name.
 
   Note that this only applies to configuration options in the
+
+.. _announcement: https://lists.fedoraproject.org/archives/list/epel-announce@lists.fedoraproject.org/message/EGUMKAIMPK2UD5VSHXM53BH2MBDGDWMO/