Merge "[COMMON] Configure paths for Ingress"

[oom.git] / docs / oom_user_guide.rst

diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst
index 70f19df..3743f5b 100644 (file)
--- a/docs/oom_user_guide.rst
+++ b/docs/oom_user_guide.rst
@@ -12,7 +12,8 @@
 .. _Helm Documentation: https://docs.helm.sh/helm/
 .. _Helm: https://docs.helm.sh/
 .. _Kubernetes: https://Kubernetes.io/
-.. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
+.. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer
+.. _`Docker installation guide`: https://docs.docker.com/engine/install/
 .. _user-guide-label:
 
 OOM User Guide
@@ -55,8 +56,12 @@ ONAP with a few simple commands.
 
 Pre-requisites
 --------------
-Your environment must have both the Kubernetes `kubectl` and Helm setup as a
-one time activity.
+Your environment must have Docker installed as well as both the Kubernetes
+`kubectl` and Helm setup as a one time activity.
+
+Install Docker
+~~~~~~~~~~~~~~
+Follow official `Docker installation guide`_.
 
 Install Kubectl
 ~~~~~~~~~~~~~~~
@@ -142,8 +147,9 @@ Then build your local Helm repository::
   > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
 
 `HELM_BIN`
-  Sets the helm binary to be used. The default value use helm from PATH. Allow the user to have
-  multiple version of helm in operating system and choose which one to use.
+  Sets the helm binary to be used. The default value use helm from PATH.
+  Allow the user to have multiple version of helm in operating system and
+  choose which one to use.
 
 The Helm search command reads through all of the repositories configured on the
 system, and looks for matches::
@@ -414,7 +420,7 @@ below::
 
 Ensure you've disabled any proxy settings the browser you are using to access
 the portal and then simply access now the new ssl-encrypted URL:
-https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm
+``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm``
 
 .. note::
   Using the HTTPS based Portal URL the Browser needs to be configured to accept
@@ -481,7 +487,7 @@ have been created - a sample from the ONAP Integration labs follows:
 .. figure:: consulHealth.png
    :align: center
 
-To see the real-time health of a deployment go to: http://<kubernetes IP>:30270/ui/
+To see the real-time health of a deployment go to: ``http://<kubernetes IP>:30270/ui/``
 where a GUI much like the following will be found: