Merge "Move proxy and default documentation"

3 files changed, 67 insertions, 41 deletions

diff --git a/bootstrap/vagrant-onap/README.md b/bootstrap/vagrant-onap/README.md
index 99d2de177..00a8a2ac7 100644
--- a/bootstrap/vagrant-onap/README.md
+++ b/bootstrap/vagrant-onap/README.md
@@ -30,53 +30,46 @@ questions faced by new developers
 
 * Windows
 
-    C:\> vagrant up <app_name>
+    PS C:\> cd integration\bootstrap\vagrant-onap
+    PS C:\integration\bootstrap\vagrant-onap> Set-ExecutionPolicy Bypass -Scope CurrentUser
+    PS C:\integration\bootstrap\vagrant-onap> .\tools\Run.ps1 <app_name>
 
 * Linux or Mac OS
 
+    $ cd integration/bootstrap/vagrant-onap
     $ ./tools/run.sh <app_name>
 
 current options include:
 
-| app_name  | description                         |
-|:---------:|-------------------------------------|
-| aai       | Active and Available Inventory      |
-| appc      | Application Controller              |
-| dcae      | Data Collection Analytics & Events  |
-| mr        | Message Router                      |
-| mso       | Master Service Orchestrator         |
-| policy    | Policy                              |
-| portal    | Portal                              |
-| robot     | Robot                               |
-| sdc       | Service Design & Creation           |
-| sdnc      | Software Defined Network Controller |
-| vid       | Virtual Infrastructure Development  |
-| vfc       | Virtual Function Controller (WIP)   |
-
-#### setting up proxy in case you are behind a firewall
-
-add http_proxy and https_proxy to your environment variables
-
-Linux or Mac
-
-    $ export http_proxy=<proxy>
-    $ export https_proxy=<proxy>
-    $ export no_proxy=<no_proxy_urls>
-
-Windows
-
-    C:\> setx http_proxy <proxy>
-    C:\> setx https_proxy <proxy>
-    C:\> setx no_proxy <no_proxy_urls>
-
-##### choosing vagrant provider
-force VirtualBox provider
-
-    C:\> vagrant up --provider=virtualbox
-
-setup the default provider on Windows
-
-    C:\> setx VAGRANT_DEFAULT_PROVIDER=virtualbox
+| app_name   | description                         |
+|:----------:|-------------------------------------|
+| aai        | Active and Available Inventory      |
+| appc       | Application Controller              |
+| dcae       | Data Collection Analytics & Events  |
+| mr         | Message Router                      |
+| mso        | Master Service Orchestrator         |
+| policy     | Policy                              |
+| portal     | Portal                              |
+| robot      | Robot                               |
+| sdc        | Service Design & Creation           |
+| sdnc       | Software Defined Network Controller |
+| vid        | Virtual Infrastructure Development  |
+| vfc        | Virtual Function Controller (WIP)   |
+| all_in_one | All ONAP services in a VM           |
+| testing    | Unit Test VM                        |
+
+#### generating documentation
+
+The documentation of this project was written in reStructuredText
+format which is located under the [docs folder](../blob/master/doc/source/index.rst).
+It's possible to format this documents to HTML using Sphinix python
+tool.
+
+    $ tox -e docs
+
+This results in the creation of a new *doc/build/html* folder with
+the documentation converted in HTML pages that can be viewed through
+the prefered Web Browser.
 
 ## Contributing
 
diff --git a/bootstrap/vagrant-onap/doc/source/index.rst b/bootstrap/vagrant-onap/doc/source/index.rst
index 509f3483f..2daccedda 100644
--- a/bootstrap/vagrant-onap/doc/source/index.rst
+++ b/bootstrap/vagrant-onap/doc/source/index.rst
@@ -11,7 +11,7 @@ using different providers like VirtualBox, Libvirt or OpenStack.
 
     __ https://wiki.onap.org/display/DW/ONAP+on+Vagrant
 
-Advanced features
+Table of contents
 -----------------
 
 .. toctree::
diff --git a/bootstrap/vagrant-onap/doc/source/install/index.rst b/bootstrap/vagrant-onap/doc/source/install/index.rst
index 248c956bb..6691b4f0d 100644
--- a/bootstrap/vagrant-onap/doc/source/install/index.rst
+++ b/bootstrap/vagrant-onap/doc/source/install/index.rst
@@ -61,3 +61,36 @@ Windows 7+ (PowerShell v2+)
     PS C:\> choco install virtualbox
 
 .. end
+
+.. note::
+
+    Some corporations use Proxy Servers to protect their assets
+    from security threats. This project uses the Proxy Environment
+    variables to connect to those servers in order to download the
+    content required during the setup. The methods to setup these
+    variables depends on the Operating system that is used.
+
+    * Linux or Mac OS
+
+    .. code-block:: console
+
+        $ export http_proxy=<proxy>
+        $ export https_proxy=<proxy>
+        $ export no_proxy=<no_proxy_urls>
+
+    .. end
+
+    * Windows
+
+    .. code-block:: console
+
+        C:\> setx http_proxy <proxy>
+        C:\> setx https_proxy <proxy>
+        C:\> setx no_proxy <no_proxy_urls>
+
+    .. end
+
+.. note::
+
+    Vagrant can be configured to use a different default provider
+    through the environment variable **VAGRANT_DEFAULT_PROVIDER**.