]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commit
doc/rados: explain replaceable parts of command
authorZac Dover <zac.dover@proton.me>
Sat, 15 Jun 2024 11:55:18 +0000 (21:55 +1000)
committerZac Dover <zac.dover@proton.me>
Sun, 16 Jun 2024 05:14:12 +0000 (15:14 +1000)
commit8cb6019a4e241661824801e8c102973f223a58b2
tree48475108174330fa7d31684bc7fd5c131b5b14eb
parent0f17fb4dcd1cf9ad1019d6d225e40199babc02db
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>
(cherry picked from commit d071ad2575c86f300a9ba39df3c4949e5dc9c47d)
doc/rados/troubleshooting/troubleshooting-mon.rst