From f5543e8a72969e36af24af05ae8940f62326a553 Mon Sep 17 00:00:00 2001
From: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com>
Date: Mon, 2 May 2022 13:39:45 -0700
Subject: [PATCH] Add dollar signs to commands in observability.md (#1619)

Also break the command in the Jaeger steps into separate lines
---
 doc/src/contribute/observability.md | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/doc/src/contribute/observability.md b/doc/src/contribute/observability.md
index 6926f4ed11cc1..be8c73964df65 100644
--- a/doc/src/contribute/observability.md
+++ b/doc/src/contribute/observability.md
@@ -176,12 +176,18 @@ Also notice `elapsed_milliseconds` which logs the duration of each span.
 
 To see nested spans visualized with [Jaeger](https://www.jaegertracing.io), do the following:
 
-1. Run this to get a local Jaeger container: `docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest`.
-1. Run Sui like this (trace enables the most detailed spans): `SUI_TRACING_ENABLE=1 RUST_LOG="info,sui_core=trace" ./sui start`.
+1. Run this to get a local Jaeger container:
+   ```shell
+   $ docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest
+   ```
+1. Run Sui like this (trace enables the most detailed spans):
+   ```shell
+   $ SUI_TRACING_ENABLE=1 RUST_LOG="info,sui_core=trace" ./sui start
+   ```
 1. Run some transfers with wallet, or run the benchmarking tool.
-1. Browse to `http://localhost:16686/` and select Sui as the Service.
+4. Browse to `http://localhost:16686/` and select Sui as the service.
 
-NOTE: separate spans (which are not nested) are not connected as a single trace for now.
+> **Note:** Separate spans (which are not nested) are not connected as a single trace for now.
 
 ### Live async inspection / Tokio Console
 
@@ -191,4 +197,4 @@ NOTE: separate spans (which are not nested) are not connected as a single trace
 2. Start Sui with `SUI_TOKIO_CONSOLE` set to 1.
 3. Clone the console repo and `cargo run` to launch the console.
 
-NOTE: Adding Tokio-console support may significantly slow down Sui validators/gateways.
+> **Note:** Adding Tokio-console support may significantly slow down Sui validators/gateways.