docs: Enclose all snippets in code blocks

This patch improves documentation readability by making all runnable
code snippets stand out.

Issue-ID: OOM-2207
Change-Id: I0ffd7892a6c3af4d91f5bdd9adb49c1e01a9c475
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>

diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index 6023565..a04306c 100644 (file)
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -69,11 +69,10 @@ The ROBOT encrypted Password uses the same encryption.key as SO but an
 openssl algorithm that works with the python based Robot Framework.
 
 .. note::
-  To generate ROBOT openStackEncryptedPasswordHere :
+  To generate ROBOT openStackEncryptedPasswordHere::
 
-  ``cd so/resources/config/mso/``
-
-  ``/oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
+    cd so/resources/config/mso/
+    /oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
 
 c. Generating SO Encrypted Password:
 The SO Encrypted Password uses a java based encryption utility since the
@@ -81,23 +80,21 @@ Java encryption library is not easy to integrate with openssl/python that
 ROBOT uses in Dublin.
 
 .. note::
-  To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword:
-
-  SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
-
-  OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
-
-  git clone http://gerrit.onap.org/r/integration
-
-  cd integration/deployment/heat/onap-rke/scripts
+  To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword
+  ensure ``default-jdk`` is installed::
 
+    apt-get update; apt-get install default-jdk
 
-  javac Crypto.java
+  Then execute::
 
-  [ if javac is not installed 'apt-get update ; apt-get install default-jdk' ]
+    SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
+    OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
 
-  java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
+    git clone http://gerrit.onap.org/r/integration
+    cd integration/deployment/heat/onap-rke/scripts
 
+    javac Crypto.java
+    java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
 
 d. Update the OpenStack parameters:
 
@@ -207,12 +204,12 @@ Use the following to monitor your deployment and determine when ONAP is ready fo
 .. note::
   While all pods may be in a Running state, it is not a guarantee that all components are running fine.
 
-  Launch the healthcheck tests using Robot to verify that the components are healthy.
+  Launch the healthcheck tests using Robot to verify that the components are healthy::
 
-  > ~/oom/kubernetes/robot/ete-k8s.sh onap health
+    > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 
-**Step 10.** Undeploy ONAP
+**Step 10.** Undeploy ONAP::
 
-> helm undeploy dev --purge
+  > helm undeploy dev --purge
 
 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins