]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commit
doc/mgr: Promptify CLI commands and other formatting fixes
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 11 Apr 2025 12:02:17 +0000 (19:02 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 11 Apr 2025 14:17:41 +0000 (21:17 +0700)
commitc4f0f8edad46c852961a622795d14b735f660d94
treeebbe4176727645da8eb3a0eae5c0ab8a608d7bb4
parent4b625ab13d5d4f5bab462e5c1ef0eb23d4ca4545
doc/mgr: Promptify CLI commands and other formatting fixes

For CLI commands use the "prompt" block feature consistently.
And remove preceding text block ending of double colon for those where
applicable.
Use the right prompt either # or $ depending if privileges needed.
Indent all CLI commands by 3 spaces which seems to be the existing
majority.
Indent some CLI command output blocks by 4 spaces, same rationale.
Fix paragraphs before CLI commands ending in rendered ".:" or ",:".
Fix some hyperlink missing underscore at end, making it a link
instead of italic text.
Use double backtick inline code formatting for filenames, paths,
command parameters, function name etc.
Fix a typo in example CLI command IP address 0.0.0.0 missing the
last 0.
Fix few example CLI commands missing the "ceph " in the beginning of
the commands.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
25 files changed:
doc/mgr/administrator.rst
doc/mgr/alerts.rst
doc/mgr/ceph_api/index.rst
doc/mgr/cli_api.rst
doc/mgr/crash.rst
doc/mgr/dashboard.rst
doc/mgr/dashboard_plugins/debug.inc.rst
doc/mgr/dashboard_plugins/feature_toggles.inc.rst
doc/mgr/dashboard_plugins/motd.inc.rst
doc/mgr/diskprediction.rst
doc/mgr/hello.rst
doc/mgr/influx.rst
doc/mgr/insights.rst
doc/mgr/iostat.rst
doc/mgr/localpool.rst
doc/mgr/mds_autoscaler.rst
doc/mgr/modules.rst
doc/mgr/nfs.rst
doc/mgr/orchestrator.rst
doc/mgr/progress.rst
doc/mgr/prometheus.rst
doc/mgr/rgw.rst
doc/mgr/smb.rst
doc/mgr/telegraf.rst
doc/mgr/telemetry.rst