Pretty print code blocks

Author: sharonx

README.md

@@ -37,20 +37,19 @@ There are multiple ways to install Splunk Connect for Docker, Splunk recommends
 
 ### Install the Plugin from Docker Store
 
-1. Pull the plugin from docker hub.
+1. Pull the plugin from docker hub
 ```
-$ docker plugin install splunk/docker-logging-plugin --alias splunk-logging-plugin
+$ docker plugin install splunk/docker-logging-plugin:latest --alias splunk-logging-plugin
 ```
 2. Enable the plugin if needed:
 ```
-$ docker plugin enable splunk-logging-plugin:latest
+$ docker plugin enable splunk-logging-plugin
 ```
 ### Install the plugin from the tar file 
 
 1. Clone the repository and check out release branch
 ```
 $ git clone  https://github.com/splunk/docker-logging-plugin.git
-$ git checkout release/2.0.0
 ```
 2. Create the plugin package
 ```
@@ -85,20 +84,20 @@ https://docs.docker.com/config/containers/logging/configure/#configure-the-deliv
 ## Examples
 
 This sample <addr>daemon.json</addr> command configures Splunk Connect for Docker for all containers on the docker engine. Splunk Software recommends that when working in a production environment, you pass your HEC token through <addr>daemon.json</addr> as opposed to the command line.
-
-	{
-  	"log-driver": "splunk-logging-plugin",
-  	"log-opts": {
-    	"splunk-url": "<splunk_hec_endpoint>",
-    	"splunk-token": "<splunk-hec-token>",
-    	"splunk-insecureskipverify": "true"
-  	}
-	}
-
+```
+{
+  "log-driver": "splunk-logging-plugin",
+  "log-opts": {
+    "splunk-url": "<splunk_hec_endpoint>",
+    "splunk-token": "<splunk-hec-token>",
+    "splunk-insecureskipverify": "true"
+  }
+}
+```
 This sample command configures Splunk Connect for Docker for a single container.
-
-	$ docker run --log-driver=splunk-logging-plugin --log-opt splunk-url=<splunk_hec_endpoint> --log-opt splunk-token=<splunk-hec_token> --log-opt splunk-insecureskipverify=true -d <docker_image>
-
+```
+$ docker run --log-driver=splunk-logging-plugin --log-opt splunk-url=<splunk_hec_endpoint> --log-opt splunk-token=<splunk-hec_token> --log-opt splunk-insecureskipverify=true -d <docker_image>
+```
 ## Step 4: Set Configuration variables
 
 Use the configuration variables to configure the behaviors and rules for Splunk Connect for Docker. For example you can confiugre your certificate security or how messages are formatted and distributed. Note the following:
@@ -111,19 +110,19 @@ Use the configuration variables to configure the behaviors and rules for Splunk
 The following is an example of the logging options specified for the Splunk Enterprise instance. In this example:
 
 The path to the root certificate and Common Name is specified using an HTTPS scheme to be used for verification. 
-
-	$ docker run --log-driver=splunk-logging-plugin\
-	--log-opt splunk-token=176FCEBF-4CF5-4EDF-91BC-703796522D20 \
-	--log-opt splunk-url=https://splunkhost:8088 \
-	--log-opt splunk-capath=/path/to/cert/cacert.pem \
-	--log-opt splunk-caname=SplunkServerDefaultCert \
-	--log-opt tag="{{.Name}}/{{.FullID}}" \
-	--log-opt labels=location \
-	--log-opt env=TEST \
-	--env "TEST=false" \
-	--label location=west \
-	<docker_image>
-
+```
+$ docker run --log-driver=splunk-logging-plugin\
+             --log-opt splunk-token=176FCEBF-4CF5-4EDF-91BC-703796522D20 \
+             --log-opt splunk-url=https://splunkhost:8088 \
+             --log-opt splunk-capath=/path/to/cert/cacert.pem \
+             --log-opt splunk-caname=SplunkServerDefaultCert \
+             --log-opt tag="{{.Name}}/{{.FullID}}" \
+             --log-opt labels=location \
+             --log-opt env=TEST \
+             --env "TEST=false" \
+             --label location=west \
+             <docker_image>
+```
 ### Required Variables
 
 Variable | Description 
@@ -173,57 +172,62 @@ There are three logging plug-in messaging formats set under the optional variabl
 * raw
 
 The default format is inline, where each log message is embedded as a string and is assigned to "line" field. For example:
-
-	{
-	"attrs": {
-	"env1": "val1",
-	"label1": "label1"
-	},
-	"tag": "MyImage/MyContainer",
-	"source": "stdout",
-	"line": "my message"
-	}
-	{
-	"attrs": {
-	"env1": "val1",
-	"label1": "label1"
-	},
-	"tag": "MyImage/MyContainer",
-	"source": "stdout",
-	"line": "{\"foo\": \"bar\"}" //though this is a string that can be marshaled to json, it is still treated as a string
-	}
-
+```
+// Example #1
+{
+    "attrs": {
+        "env1": "val1",
+        "label1": "label1"
+    },
+    "tag": "MyImage/MyContainer",
+    "source":  "stdout",
+    "line": "my message"
+}
+
+// Example #2
+{
+    "attrs": {
+        "env1": "val1",
+        "label1": "label1"
+    },
+    "tag": "MyImage/MyContainer",
+    "source":  "stdout",
+    "line": "{\"foo\": \"bar\"}"
+}
+```
 When messages are JSON objects, you may want to embed them in the message sent to Splunk.
 
 To format messages as json objects, set --log-opt splunk-format=json. The plug-in will try to parse every line as a JSON object and embed the json object to "line" field. If it cannot parse the message, it is sent inline. For example:
-
-	{
-	"attrs": {
-	"env1": "val1",
-	"label1": "label1"
-	},
-	"tag": "MyImage/MyContainer",
-	"source": "stdout",
-	"line": "my message" //fall back to a string
-	}
-	{
-	"attrs": {
-	"env1": "val1",
-	"label1": "label1"
-	},
-	"tag": "MyImage/MyContainer",
-	"source": "stdout",
-	"line": {
-	"foo": "bar"
-	}
-	}
-
+```
+//Example #1
+{
+    "attrs": {
+        "env1": "val1",
+        "label1": "label1"
+    },
+    "tag": "MyImage/MyContainer",
+    "source":  "stdout",
+    "line": "my message"
+}
+
+//Example #2
+{
+    "attrs": {
+        "env1": "val1",
+        "label1": "label1"
+    },
+    "tag": "MyImage/MyContainer",
+    "source":  "stdout",
+    "line": {
+        "foo": "bar"
+    }
+}
+```
 If --log-opt splunk-format=raw, each message together with attributes (environment variables and labels) and tags are combined in a raw string. Attributes and tags are prefixed to the message. For example:
-
-	#<tag> <env=value> <label=value> <logging_messaage>
-	MyImage/MyContainer env1=val1 label1=label1 my message
-	MyImage/MyContainer env1=val1 label1=label1 {"foo": "bar"}
-
+```
+MyImage/MyContainer env1=val1 label1=label1 my message
+MyImage/MyContainer env1=val1 label1=label1 {"foo": "bar"}
+```
 # Troubleshooting
 
 If your Splunk Connector for Docker does not behave as expected, use the debug functionality and then refer to the following tips included in output.
@@ -235,11 +239,11 @@ Plugin logs can be found as docker daemon log. To enable debug mode, export envi
 ## Use the debugger to check your debug the Splunk HEC connection
 
 Check HEC endpoint accessibility Docker environment. If the endpoint cannot be reached, debug logs are not sent to Splunk, or the logs or will buffer and drop as they roll off the buffer. 
-
-	Test HEC endpoint is accessible
-	$ curl -k https://<ip_address>:8088/services/collector/health
-	{"text":"HEC is healthy","code":200}
-
+```
+Test HEC endpoint is accessible
+$ curl -k https://<ip_address>:8088/services/collector/health
+{"text":"HEC is healthy","code":200}
+```
 ## Check your HEC configuration for clusters
 
 If you are using an Indexer Cluster, the current plugin accepts a single splunk-url value. We recommend that you configure a load balancer in front of your Indexer tier. Make sure the load balancer can successfully tunnel the HEC requests to the indexer tier. If HEC is configured in an Indexer Cluster environment, all indexers should have same HEC token configured. See http://docs.splunk.com/Documentation/Splunk/7.0.3/Data/UsetheHTTPEventCollector.  
@@ -253,10 +257,10 @@ If you ae using a heavy forwarder to preprocess the events (e.g: funnel multiple
 Stdout of a plugin is redirected to Docker logs. Such entries have a plugin=<ID> suffix.
 
 To find out the plugin ID of Splunk Connect for Docker, use the command below and look for Splunk Logging Plugin entry.
-
-	# list all the plugins
-	$ docker plugin ls
-
+```
+# list all the plugins
+$ docker plugin ls
+```
 Depending on your system, location of Docker daemon logging may vary.  Refer to Docker documentation for Docker daemon log location for your specific platform. Here are a few examples:
 
 * Ubuntu (old using upstart ) - /var/logging/upstart/docker.logging