]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commit
doc: README.md - improve "Tshooting" and "Tips & Tricks"
authorZac Dover <zac.dover@proton.me>
Sat, 4 Jan 2025 20:54:48 +0000 (06:54 +1000)
committerZac Dover <zac.dover@proton.me>
Sat, 4 Jan 2025 20:56:57 +0000 (06:56 +1000)
commitc0e91389b03e3cc0602bad3511e7a18d3dff0c16
treeaadcff3b6ed988a56c23bc048a3337e763ee4664
parent316d3c1f6942d4c38f26c98cfe4b284ad87344fc
doc: README.md - improve "Tshooting" and "Tips & Tricks"

Improve the formatting and English language in the sections
"Troubleshooting" and "Tips and Tricks", and move those sections to a
place where they don't interrupt the flow of the vstart cluster
installation instructions. Some of the strings in "Tips and Tricks" are
not yet unambiguous sentences that will make sense to the uninitiated,
but this PR represents a step in that direction.

This PR is part of a series of PRs meant to preserve the integrity of
the README.md file after some recent additions that break the flow of
the document.

This PR follows https://github.com/ceph/ceph/pull/61226 and
https://github.com/ceph/ceph/pull/61221.

Signed-off-by: Zac Dover <zac.dover@proton.me>
README.md