]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commit
doc/start: update prompts in documenting-ceph.rst 38078/head
authorZac Dover <zac.dover@gmail.com>
Sat, 14 Nov 2020 07:22:35 +0000 (17:22 +1000)
committerZac Dover <zac.dover@gmail.com>
Mon, 16 Nov 2020 14:13:05 +0000 (00:13 +1000)
commit2b90e77802afbcea2a14e441046c6fa8b2e0059d
tree4d2752674dda40709b44f497dd4f477e342df627
parent1464a7d588734f0bbfa1d283ac97e8bcf9dd85a3
doc/start: update prompts in documenting-ceph.rst

This commit adds the ".. prompt:: bash $" directive
to the commands in "documenting-ceph.rst" so that
the permissions level of each command is evident
(through the presentation of the $ or the #), and
so that when the reader cuts and pastes the commands
from the documentation, they don't have to delete
the prompt (because that's how this directive
renders).

This commit also instructs the reader to add the
directory containing "build-doc" and
"serve-doc" to the PATH environment variable
in order to run the commands.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
doc/start/documenting-ceph.rst