From: Zac Dover <zac.dover@proton.me>
Date: Tue, 20 May 2025 05:44:48 +0000 (+1000)
Subject: doc/mgr: edit motd.inc.rst
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=8661509c16441d60778bc084df8231daa149a04b;p=ceph.git

doc/mgr: edit motd.inc.rst

Edit doc/mgr/dashboard_plugins/motd.inc.rst.

This commit is part of a project to separate out the twenty-five files
that were committed to https://github.com/ceph/ceph/pull/62782.

Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/doc/mgr/dashboard_plugins/motd.inc.rst b/doc/mgr/dashboard_plugins/motd.inc.rst
index 0f9cc199a9737..61aa9b7b0ada6 100644
--- a/doc/mgr/dashboard_plugins/motd.inc.rst
+++ b/doc/mgr/dashboard_plugins/motd.inc.rst
@@ -3,34 +3,36 @@
 Message of the day (MOTD)
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Displays a configured `message of the day` at the top of the Ceph Dashboard.
+Displays a configured "message of the day" (MOTD) at the top of the Ceph
+Dashboard.
 
-The importance of a MOTD can be configured by its severity, which is
-`info`, `warning` or `danger`. The MOTD can expire after a given time,
+The importance of an MOTD can be configured by its severity, which is
+``info``, ``warning`` or ``danger``. The MOTD can expire after a given time,
 this means it will not be displayed in the UI anymore. Use the following
-syntax to specify the expiration time: `Ns|m|h|d|w` for seconds, minutes,
-hours, days and weeks. If the MOTD should expire after 2 hours, use `2h`
-or `5w` for 5 weeks. Use `0` to configure a MOTD that does not expire.
+syntax to specify the expiration time: ``Ns|m|h|d|w``, where ``N`` is an
+integer followed by seconds, minutes, hours, days and weeks. If the MOTD
+should expire after 2 hours, use ``2h`` or ``5w`` for 5 weeks. Use ``0`` to
+configure a MOTD that does not expire.
 
 To configure a MOTD, run the following command:
 
-.. prompt:: bash $
+.. prompt:: bash #
 
    ceph dashboard motd set <severity:info|warning|danger> <expires> <message>
 
 To show the configured MOTD:
 
-.. prompt:: bash $
+.. prompt:: bash #
 
    ceph dashboard motd get
 
 To clear the configured MOTD run:
 
-.. prompt:: bash $
+.. prompt:: bash #
 
    ceph dashboard motd clear
 
-A MOTD with a `info` or `warning` severity can be closed by the user. The
-`info` MOTD is not displayed anymore until the local storage cookies are
-cleared or a new MOTD with a different severity is displayed. A MOTD with
-a 'warning' severity will be displayed again in a new session.
+A MOTD with a severity of ``info`` or ``warning`` can be closed by the user.
+The ``info`` MOTD is not displayed until the local storage cookies are
+cleared or a new MOTD with a different severity is displayed. A MOTD with a
+``warning`` severity will be displayed again in a new session.