Skip to content

Commit ab7adce

Browse files
committed
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 ceph#62782. Signed-off-by: Zac Dover <[email protected]> (cherry picked from commit 8661509)
1 parent bcae93b commit ab7adce

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

doc/mgr/dashboard_plugins/motd.inc.rst

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,36 @@
33
Message of the day (MOTD)
44
^^^^^^^^^^^^^^^^^^^^^^^^^
55

6-
Displays a configured `message of the day` at the top of the Ceph Dashboard.
6+
Displays a configured "message of the day" (MOTD) at the top of the Ceph
7+
Dashboard.
78

8-
The importance of a MOTD can be configured by its severity, which is
9-
`info`, `warning` or `danger`. The MOTD can expire after a given time,
9+
The importance of an MOTD can be configured by its severity, which is
10+
``info``, ``warning`` or ``danger``. The MOTD can expire after a given time,
1011
this means it will not be displayed in the UI anymore. Use the following
11-
syntax to specify the expiration time: `Ns|m|h|d|w` for seconds, minutes,
12-
hours, days and weeks. If the MOTD should expire after 2 hours, use `2h`
13-
or `5w` for 5 weeks. Use `0` to configure a MOTD that does not expire.
12+
syntax to specify the expiration time: ``Ns|m|h|d|w``, where ``N`` is an
13+
integer followed by seconds, minutes, hours, days and weeks. If the MOTD
14+
should expire after 2 hours, use ``2h`` or ``5w`` for 5 weeks. Use ``0`` to
15+
configure a MOTD that does not expire.
1416

1517
To configure a MOTD, run the following command:
1618

17-
.. prompt:: bash $
19+
.. prompt:: bash #
1820

1921
ceph dashboard motd set <severity:info|warning|danger> <expires> <message>
2022

2123
To show the configured MOTD:
2224

23-
.. prompt:: bash $
25+
.. prompt:: bash #
2426

2527
ceph dashboard motd get
2628

2729
To clear the configured MOTD run:
2830

29-
.. prompt:: bash $
31+
.. prompt:: bash #
3032

3133
ceph dashboard motd clear
3234

33-
A MOTD with a `info` or `warning` severity can be closed by the user. The
34-
`info` MOTD is not displayed anymore until the local storage cookies are
35-
cleared or a new MOTD with a different severity is displayed. A MOTD with
36-
a 'warning' severity will be displayed again in a new session.
35+
A MOTD with a severity of ``info`` or ``warning`` can be closed by the user.
36+
The ``info`` MOTD is not displayed until the local storage cookies are
37+
cleared or a new MOTD with a different severity is displayed. A MOTD with a
38+
``warning`` severity will be displayed again in a new session.

0 commit comments

Comments
 (0)