Add documentation

README.md

@@ -13,24 +13,29 @@ Additional docs for using Sonarqube and its plugins can be found at https://docs
 
 Install kubectl
 
-```bash
-$ brew install kubectl
 ```
+brew install kubectl
+```
+
 Install kustomize 
 
-```bash
-$ brew install kustomize
+```
+brew install kustomize
 ```
 
 ### Deployment
 
 Clone repository
-```bash
-$ git clone https://repo1.dsop.io/platform-one/apps/sonarqube.git
-$ cd sonarqube
+
+```
+git clone https://repo1.dsop.io/platform-one/apps/sonarqube.git
 ```
 
-** Please note that appropriate secrets (listed below) should be defined before the sonarqube pod is able to connect to the postgres database and is able to function properly.
+```
+cd sonarqube
+```
+
+Please note that appropriate secrets (listed below) should be defined before the sonarqube pod is able to connect to the postgres database and is able to function properly.
 Sonarqube needs three environment variables to access the postgres database.
 
 SONARQUBE_JDBC_URL - URL for the postgres database to use
@@ -44,8 +49,8 @@ These need to be added in as Kubernetes secrets and mounted into the sonarqube p
 To run Sonarqube, add the secrets, volumes, volumeMounts and env to set values for the above variables. 
 After the above secrets are incorporated into the sonarqube/ manifests, to deploy Sonarqube apply the kustomized manifest:
 
-```bash
-$ kubectl apply -k sonarqube/
+```
+kubectl apply -k sonarqube/
 ```
 
 ### IMPORTANT  Default Admin Credentials
@@ -58,9 +63,13 @@ Password: admin
 You can change the administrator password from the SonarQube dashboard by following these steps:
 
 1)Log in to the SonarQube dashboard.
+
 2)Under the “User Name” dropdown menu in the upper right corner, click on “My Account”.
+
 3)Select the “Security” tab.
+
 4)Enter your old password and enter your new password twice to confirm the change.
+
 5)Click the “Change password” button.
 
 ## Contributing