ceph/doc/rados
Zac Dover d071ad2575 doc/rados: explain replaceable parts of command
Add an explanation that directs the reader to replace the "X" part of
the command "ceph tell mon.X mon_status" with the value specific to the
reader's Ceph cluster (which is (probably) not "X").

In the future, such replaceable strings in commands may be bounded by
angle brackets ("<" and ">").

This improvement to the documentation was suggested on the [ceph-users]
email list by Joel Davidow. This email, an absolute model of user
engagement with an upstream project, can be reviewed here:
https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/message/KF67F5TXFSSTPXV7EKL6JKLA5KZQDLDQ/

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-15 21:55:18 +10:00
..
api doc/glossary: add "librados" entry 2024-03-14 16:29:09 +10:00
command
configuration doc/rados: add options to network config ref 2024-06-05 14:30:01 +10:00
man
operations doc/rados: add pg-states and pg-concepts to tree 2024-06-13 21:29:47 +10:00
troubleshooting doc/rados: explain replaceable parts of command 2024-06-15 21:55:18 +10:00
index.rst