New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc/rados/operations: add prompts to operating.rst #47580
doc/rados/operations: add prompts to operating.rst #47580
Conversation
This commit adds ".. prompt:: bash $"-style prompts to operating.rst. This brings this file up to the standard established in 2020 when Kefu added support for the ".. prompt::" directive. This commit is a part of an initiative to modernize the presentation of all BASH commands in the RADOS documentation. The progress of this project can be tracked here: https://tracker.ceph.com/issues/57108 Signed-off-by: Zac Dover <zac.dover@gmail.com>
|
||
.. prompt:: bash $ | ||
|
||
sudo systemctl status ceph\*.service ceph\*.target | ||
|
||
Starting all Daemons | ||
-------------------- | ||
|
||
To start all daemons on a Ceph Node (irrespective of type), execute the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest To start all Ceph daemons on a node (irrespective of role), execute the
sudo systemctl stop ceph\*.service ceph\*.target | ||
.. prompt:: bash $ | ||
|
||
sudo systemctl stop ceph\*.service ceph\*.target | ||
|
||
|
||
Starting all Daemons by Type | ||
---------------------------- | ||
|
||
To start all daemons of a particular type on a Ceph Node, execute one of the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To start all Ceph daemons of a particular type on a node, execute one of the
sudo systemctl start ceph-mds.target | ||
sudo systemctl start ceph-osd.target | ||
sudo systemctl start ceph-mon.target | ||
sudo systemctl start ceph-mds.target | ||
|
||
|
||
Stopping all Daemons by Type | ||
---------------------------- | ||
|
||
To stop all daemons of a particular type on a Ceph Node, execute one of the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To stop all Ceph daemons of a particular type on a node, execute one of the
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM overall. I left a few comments suggesting more specific wording, but that doesn't warrant holding up approval.
I'll add this to a list of textual changes to be made during a future editorial pass. Expect that editorial pass to begin sometime within the next two weeks, when all of the prompts have been modernized. |
This commit adds ".. prompt:: bash $"-style prompts to operating.rst.
This brings this file up to the standard established in 2020 when
Kefu added support for the ".. prompt::" directive.
This commit is a part of an initiative to modernize the presentation
of all BASH commands in the RADOS documentation.
The progress of this project can be tracked here:
https://tracker.ceph.com/issues/57108
Signed-off-by: Zac Dover zac.dover@gmail.com
Contribution Guidelines
To sign and title your commits, please refer to Submitting Patches to Ceph.
If you are submitting a fix for a stable branch (e.g. "pacific"), please refer to Submitting Patches to Ceph - Backports for the proper workflow.
Checklist
Show available Jenkins commands
jenkins retest this please
jenkins test classic perf
jenkins test crimson perf
jenkins test signed
jenkins test make check
jenkins test make check arm64
jenkins test submodules
jenkins test dashboard
jenkins test dashboard cephadm
jenkins test api
jenkins test docs
jenkins render docs
jenkins test ceph-volume all
jenkins test ceph-volume tox
jenkins test windows