From: Zac Dover <zac.dover@proton.me>
Date: Fri, 3 Jan 2025 19:52:24 +0000 (+1000)
Subject: doc: README.md - format "Troubleshooting"
X-Git-Tag: testing/wip-mchangir-testing-PR60889-main-debug~14^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=acbb2e507839a5b4d2e1c8436ec56854d204f088;p=ceph-ci.git

doc: README.md - format "Troubleshooting"

Format "Troubleshooting" into its own section so that it doesn't confuse
readers of the vstart installation procedure.

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/61221.

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

diff --git a/README.md b/README.md
index 3c781e532f3..a3fdfada623 100644
--- a/README.md
+++ b/README.md
@@ -137,15 +137,14 @@ To build Ceph, follow this procedure:
    * Preserve Existing Data skip cluster reinitialization between tests by
      using the `-n` flag.
 
-    > [TROUBLESHOOTING]
-    >
-    >Cluster Fails to Start: Look for errors in the logs under the out/ directory, e.g.
-    >
-    >OSD Crashes: Check the OSD logs for errors.
-    >
-    >Cluster in a Health Error State: Run `ceph status` to identify the issue.
-    >
-    >RocksDB Errors: Look for RocksDB-related errors in OSD logs.
+##  Troubleshooting     
+ 
+    * Cluster Fails to Start: Look for errors in the logs under the `out/`
+      directory.
+    * OSD Crashes: Check the OSD logs for errors.
+    * Cluster in a `Health Error` State: Run the `ceph status` command to
+      identify the issue.
+    * RocksDB Errors: Look for RocksDB-related errors in the OSD logs.
     
     To manage a vstart cluster, stop daemons using `./stop.sh` and start them with ./vstart.sh --daemon osd.${ID} [--nodaemonize]. 
     Restart by stopping and restarting daemons, ensuring no stale sockets.