Merge pull request #127 from iranzo/formatting

doc: Adjust formatting

Author: ptrnull

scripts/README.md

@@ -2,7 +2,7 @@
 
 A set of scripts to run basic checks on an OpenShift cluster. PRs welcome!
 
-> :warning: This is an unofficial tool, don't blame us if it breaks your cluster
+This >:warning: is an unofficial tool, don't blame us if it breaks your cluster
 
 ## ovn_cleanConntrack.sh
 
@@ -42,7 +42,7 @@ Single node execution:
 $ ./ovn_cleanConntrack.sh -s my.node.com
 ```
 
-For the -k parameter, the original behavior is still the same but if you want to analyse different clusters from the same bastion you can do it using the -k parameter to pass the kubeconfig file to the script, for example:
+For the -k parameter, the original behavior is still the same but if you want to analyze different clusters from the same bastion you can do it using the -k parameter to pass the kubeconfig file to the script, for example:
 
 ```bash
 $ ./ovn_cleanConntrack.sh -k /home/kni/clusterconfigs/cluster1/auth/kubeconfig
@@ -56,15 +56,16 @@ If no -k is indicated the script expects to have the KUBECONFIG variable exporte
 For the -q parameter, instead of printing the output to the standard output now you can indicate the file were to save the output of the script, to cover the commented use case for running on batch mode:
 
 ```bash
+
 $ ./ovn_cleanConntrack.sh -k /home/kni/clusterconfigs/cluster1/auth/kubeconfig -q /tmp/cluster1.output
 $ ./ovn_cleanConntrack.sh -k /home/kni/clusterconfigs/cluster2/auth/kubeconfig -q /tmp/cluster2.output
 $ ./ovn_cleanConntrack.sh -k /home/kni/clusterconfigs/cluster3/auth/kubeconfig -q /tmp/cluster3.output
 ```
 
-If no conntracks with issues are found the files `/tmp/cluster?.output` won't be created. If no -q is indicated, the script will print the results in the standard output.
+If no conntracks with issues are found the files `/tmp/cluster?.output` won't be created. If no `-q` is indicated, the script will print the results in the standard output.
 
-Here is an example on how to configure a cronjob to run the script every hour (you can place it on /etc/cron.d/1conntracks).
-This example uses the parameters -k and -q indicating the kubeconfig and the file to save the output:
+Here is an example of how to configure a cronjob to run the script every hour (you can place it on `/etc/cron.d/1conntracks`).
+This example uses the parameters `-k` and `-q` indicating the kubeconfig and the file to save the output:
 
 ```bash
 # Run hourly
@@ -76,13 +77,13 @@ MAILTO=root
 20 * * * * kni /usr/local/bin/ovn_cleanConntrack.sh -k /home/kni/clusterconfigs/cluster3/auth/kubeconfig -q /tmp/ovnconntracks_cluster3.log
 ```
 
-In that example, the debug log is still being generated using the LOG var inside the script, but that is a debug log file in case we need to debug the script behaviour, and it can be modified according to bastion space and needs.
+In that example, the debug log is still being generated using the LOG var inside the script, but that is a debug log file in case we need to debug the script behavior, and it can be modified according to bastion space and needs.
 
 ## recover-northd.sh
 
 ### Usage
 
-````bash
+```bash
 $ ./recover-northd.sh -h
 This script checks if northd is stuck and optionally intervene
 
@@ -91,15 +92,17 @@ This script checks if northd is stuck and optionally intervene
         Save extra DEBUG lines into the log: recover-northd.sh -d
         Set the KUBECONFIG env var to /kubeconfig/file: recover-northd.sh -k /kubeconfig/file
  				Remediate the issue: recover-northd.sh -r
+```
 
-After the execution a logfile will be generated with the name recover-northd.DATE.log
+After the execution, a logfile will be generated with the name `recover-northd.DATE.log`
 
 ### Examples
 
 Saving extra debug lines in the log file:
+
 ```bash
 $ ./recover-northd.sh -d
-````
+```
 
 For the -k parameter, the original behavior is still the same but if you want to analyse different clusters from the same bastion you can do it using the -k parameter to pass the kubeconfig file to the script, for example:
 
@@ -110,9 +113,10 @@ $ ./recover-northd.sh -k /home/kni/clusterconfigs/cluster3/auth/kubeconfig
 ```
 
 In the previous example, the script will analyse the clusters indicated by the kubeconfig files on `/home/kni/clusterconfigs/cluster1/kubeconfig`, `/home/kni/clusterconfigs/cluster2/kubeconfig` and `/home/kni/clusterconfigs/cluster3/kubeconfig`
-If no -k is indicated the script expects to have the KUBECONFIG variable exported in the system otherwise it will give an error because it can't connect.
 
-For the -r parameter, the script will send an exit to the northd container for OVN to elect a new leader:
+If no `-k` is indicated the script expects to have the KUBECONFIG variable exported in the system otherwise it will give an error because it can't connect.
+
+For the `-r` parameter, the script will send an exit to the northd container for OVN to elect a new leader:
 
 ```bash
 $ ./recover-northd.sh -k /home/kni/clusterconfigs/cluster1/auth/kubeconfig -r