updating the install config file for readthedocs

IssueId: SO-300

Change-Id: If9f9421b80acdd657efffcb47c231b94db9193dd
Signed-off-by: seshukm <seshu.kumar.m@huawei.com>

diff --git a/docs/Install_Configure_SO.rst b/docs/Install_Configure_SO.rst
index 5771a10..a1a9bf4 100644 (file)
--- a/docs/Install_Configure_SO.rst
+++ b/docs/Install_Configure_SO.rst
@@ -18,79 +18,147 @@ Make sure you have the VirtualBox Guest Additions ISO for your version of Virtua
 Create a new VM in VirtualBox for Ubuntu\r
 ----------------------------------------\r
 Type: Linux\r
+\r
 Version: Ubuntu (64-bit)\r
+\r
 At least 2048 MB memory\r
+\r
 At least 40 GB VDI\r
+\r
 Network: Attached to: NAT\r
 \r
 Create a port-forwarding rule for SSH\r
 -------------------------------------\r
 Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.\r
+\r
 Go to "Network" settings in VirtualBox, add a port forwarding rule:\r
+\r
 Name: SSH\r
+\r
 Protocol: TCP\r
+\r
 Host IP: 127.0.0.1\r
+\r
 Host Port: 1022\r
+\r
 Guest IP: <leave blank>\r
+\r
 Guest Port: 22\r
 \r
+.. image:: images/Configure_ubuntu_SO_1.png\r
+\r
+.\r
+\r
+.. image:: images/Configure_ubuntu_SO_2.png\r
+\r
 Create Shared Folder\r
 --------------------\r
 This is oriented to Windows users.  If you're using a MAC or a Linux host computer, the details may be different.  You can share any folder on the host computer with the Ubuntu VM.  On Windows, a practical choice is to share the C:\Users folder, so that your Windows home directory will be accessible from the Ubuntu VM.\r
+\r
 Go to "Shared Folders" settings in VirtualBox, add a share:\r
+\r
 Folder Path: C:\Users\r
+\r
 Folder Name: Users\r
+\r
 Auto-mount: <checked>\r
+\r
 Read-only: <unchecked>\r
 \r
+.. image:: images/Configure_ubuntu_SO_3.png\r
+\r
+.\r
+\r
+.. image:: images/Configure_ubuntu_SO_4.png\r
+\r
 Install Ubuntu in the VM\r
 ------------------------\r
 On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your Ubuntu ISO image.\r
 \r
+.. image:: images/Configure_ubuntu_SO_5.png\r
+\r
 After selecting the ISO image, start the VM.\r
+\r
 Follow the prompts to install Ubuntu.\r
 \r
 Proxy Configuration (optional)\r
 ------------------------------\r
 If you're behind a corporate firewall, configure some proxy settings.  NOTE: your proxy configuration may require username and password credentials, not shown here.\r
 **Ubuntu system proxy setting:**\r
+\r
        System Settings → Network → Network proxy\r
+       \r
        (Replace "proxyhost" and port with your actual proxy information)\r
 \r
+.. image:: images/Configure_ubuntu_SO_6.png\r
+       \r
 **apt proxy setting:**\r
        Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):\r
+       \r
                Acquire::http::Proxy "http://proxyhost:port";\r
+               \r
        Reboot the VM.\r
        \r
 Install SSH Server\r
 ------------------\r
-sudo apt update\r
-sudo apt install openssh-server\r
+\r
+.. code-block:: bash\r
+\r
+    sudo apt update\r
+    sudo apt install openssh-server\r
 \r
 Connect to the VM from your host computer\r
 -----------------------------------------\r
        The PuTTY SSH client is popular.  A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.\r
 \r
+.. image:: images/Configure_ubuntu_SO_7.png\r
+       \r
 Install VirtualBox Guest Additions\r
 ----------------------------------\r
 On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your VirtualBox Guest Additions ISO image.\r
 \r
+.. image:: images/Configure_ubuntu_SO_8.png\r
+\r
 In a VM terminal window, mount the cdrom:\r
+\r
+.. code-block:: bash\r
+\r
        sudo mkdir -p /media/cdrom\r
        sudo mount /dev/cdrom /media/cdrom\r
+       \r
 Install necessary dependencies:\r
-       sudo apt update\r
-       sudo apt install gcc g++ dkms\r
+\r
+.. code-block:: bash\r
+\r
+    sudo apt update\r
+    sudo apt install gcc g++ dkms\r
+       \r
 Install the guest additions.  NOTE: look for errors in the command output!  If you see an error that says you are missing kernel headers, the most likely cause is that you are using a VirtualBox version that is too old.  The error message is misleading.\r
+\r
+.. code-block:: bash\r
+\r
        cd /media/cdrom\r
        sudo ./VBoxLinuxAdditions.run\r
 \r
+.. image:: images/Configure_ubuntu_SO_9.png    \r
+       \r
 Add yourself to the vboxsf user group (replace "userid" with your user ID):\r
+       \r
+.. code-block:: bash   \r
+       \r
        sudo usermod -a -G vboxsf userid\r
+       \r
 Reboot the VM.\r
+\r
 In a VM terminal window, verify that you can access your home directory on the host computer, which should be mounted under here:\r
        /media/sf_Users\r
        \r
 Further Reading\r
 ----------------------------------------       \r
-https://wiki.onap.org/display/DW/Development+Environment
\ No newline at end of file
+\r
+.. toctree::\r
+   :maxdepth: 1\r
+\r
+   Install_Docker.rst\r
+   Configure_git_and_gerrit.rst\r
+   Workspace_and_Development_Tools.rst
\ No newline at end of file

diff --git a/docs/UUI-SO API Specification v0.1(1).docx b/docs/UUI-SO API Specification v0.1(1).docx
deleted file mode 100644 (file)
index a6dfbd0..0000000
Binary files a/docs/UUI-SO API Specification v0.1(1).docx and /dev/null differ