Fix doc8 errors

IssueId: SO-319

Change-Id: Ie5079abe0bc5ed249fa6239a6b9386149aee90b6
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

2 files changed, 205 insertions, 189 deletions

diff --git a/docs/Configure_git_and_gerrit.rst b/docs/Configure_git_and_gerrit.rst
index ccd0785b98..c4598faf7b 100644
--- a/docs/Configure_git_and_gerrit.rst
+++ b/docs/Configure_git_and_gerrit.rst
@@ -1,92 +1,93 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.

-.. http://creativecommons.org/licenses/by/4.0

-.. Copyright 2017 Huawei Technologies Co., Ltd.

-

-Configure git and gerrit

-========================

-

-Basics

-------

-The recommended version of git is 2.7.4 or later.  Check the installed version in the Ubuntu VM:

-

-.. code-block:: bash

-

-	git --version

-

-Create an SSH key to user with gerrit.  Use no passphrase.

-

-.. code-block:: bash

-

-	ssh-keygen -t rsa

-	

-Enter your SSH public key (id_rsa) into gerrit:

-	Browse to https://gerrit.onap.org

-	Log in

-	Open the menu next to your name (under the green search button)

-	

-.. image:: images/Configure_git_1.png

-

-	Select "Settings"

-	In the "Settings" sidebar, click "SSH Public Keys"`

-	Click "Add Key..."

-	Paste the entire contents of $HOME/.ssh/id_rsa.pub into the text area and click "Add".

-	

-.. image:: images/Configure_git_2.png

-

-Install the git-review package.

-

-.. code-block:: bash

-

-	sudo apt update

-	sudo apt install git-review

-	

-Create $HOME/.gitconfig (replace highlighted values with your own information):

-	[user]

-	

-        name = FirstName LastName

-		

-        email = you@yourcompany.com

-		

-	[core]

-	

-        autocrlf = false

-		

-	[merge]

-	

-        tool = vimdiff

-		

-	[gitreview]

-	

-        username = YourLinuxFoundationId

-		

-**If you're behind a corporate firewall and your proxy server has SOCKS support...**

-

-You may be able to use the SSH protocol with git, which is preferred versus HTTP.  This method is known to work in the AT&T corporate network.

-Install the socat package, which allows you to tunnel SSH connections through a proxy that supports SOCKS:

-

-.. code-block:: bash

-

-	sudo apt update

-	sudo apt install socat

-	

-Create (or append to) $HOME/.ssh/config (replace highlighted values with your information)

-

-	Host gerrit.onap.org

-	

-	User userid

-	

-	Hostname gerrit.onap.org

-	

-	ProxyCommand socat - PROXY:host:%h:%p,proxyport=port

-	

-	IdentityFile /home/userid/.ssh/id_rsa

-	

-	ServerAliveInterval 10

-

-Verify that you have connectivity to gerrit through the proxy.  Answer "yes" to continue connecting, if prompted.

-

-.. code-block:: bash

-

-	ssh -p 29418 gerrit.onap.org

-	

-.. image:: images/Configure_git_3.png
\ No newline at end of file
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+Configure git and gerrit
+========================
+
+Basics
+------
+The recommended version of git is 2.7.4 or later.  Check the installed version in the Ubuntu VM:
+
+.. code-block:: bash
+
+  git --version
+
+Create an SSH key to user with gerrit.  Use no passphrase.
+
+.. code-block:: bash
+
+  ssh-keygen -t rsa
+
+Enter your SSH public key (id_rsa) into gerrit:
+
+- Browse to https://gerrit.onap.org
+- Log in
+- Open the menu next to your name (under the green search button)
+
+.. image:: images/Configure_git_1.png
+
+- Select "Settings"
+- In the "Settings" sidebar, click "SSH Public Keys"`
+- Click "Add Key..."
+- Paste the entire contents of $HOME/.ssh/id_rsa.pub into the text area and click "Add".
+
+.. image:: images/Configure_git_2.png
+
+Install the git-review package.
+
+.. code-block:: bash
+
+  sudo apt update
+  sudo apt install git-review
+
+Create $HOME/.gitconfig (replace highlighted values with your own information):
+  [user]
+
+        name = FirstName LastName
+
+        email = you@yourcompany.com
+
+  [core]
+
+        autocrlf = false
+
+  [merge]
+
+        tool = vimdiff
+
+  [gitreview]
+
+        username = YourLinuxFoundationId
+
+**If you're behind a corporate firewall and your proxy server has SOCKS support...**
+
+You may be able to use the SSH protocol with git, which is preferred versus HTTP.  This method is known to work in the AT&T corporate network.
+Install the socat package, which allows you to tunnel SSH connections through a proxy that supports SOCKS:
+
+.. code-block:: bash
+
+  sudo apt update
+  sudo apt install socat
+
+Create (or append to) $HOME/.ssh/config (replace highlighted values with your information)
+
+  Host gerrit.onap.org
+
+  User userid
+
+  Hostname gerrit.onap.org
+
+  ProxyCommand socat - PROXY:host:%h:%p,proxyport=port
+
+  IdentityFile /home/userid/.ssh/id_rsa
+
+  ServerAliveInterval 10
+
+Verify that you have connectivity to gerrit through the proxy.  Answer "yes" to continue connecting, if prompted.
+
+.. code-block:: bash
+
+  ssh -p 29418 gerrit.onap.org
+
+.. image:: images/Configure_git_3.png
diff --git a/docs/installation.rst b/docs/installation.rst
index fc5af916e1..07f534e1b3 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -1,97 +1,112 @@
-.. _open_cli_schema_version_1_0:

-.. This work is licensed under a Creative Commons Attribution 4.0 International License.

-.. http://creativecommons.org/licenses/by/4.0

-.. Copyright 2017 Huawei Technologies Co., Ltd.

-

-Install and Configure Service Orchestrator

-==========================================

-

-Get Ubuntu

-----------

-Get the Ubuntu ISO image from ubuntu.com. The recommended version is 16.04.3 LTS (Long Term Support), desktop edition.

-

-Get VirtualBox and VirtualBox Guest Additions

----------------------------------------------

-Make sure you have the VirtualBox Guest Additions ISO for your version of VirtualBox.  I'm using VirtualBox 5.1.28.  Save the Guest Additions ISO on your host computer along with the Ubuntu ISO.  Get the Guest Additions ISO from here:

-	http://download.virtualbox.org/virtualbox

-*NOTE*: Guest Additions versions prior to 5.1 will not work with Ubuntu 16.04.3.  If you have an earlier version of VirtualBox, you should upgrade to the latest 5.1 version.

-

-Create a new VM in VirtualBox for Ubuntu

-----------------------------------------

-Type: Linux

-Version: Ubuntu (64-bit)

-At least 2048 MB memory

-At least 40 GB VDI

-Network: Attached to: NAT

-

-Create a port-forwarding rule for SSH

--------------------------------------

-Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.

-Go to "Network" settings in VirtualBox, add a port forwarding rule:

-Name: SSH

-Protocol: TCP

-Host IP: 127.0.0.1

-Host Port: 1022

-Guest IP: <leave blank>

-Guest Port: 22

-

-Create Shared Folder

---------------------

-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.

-Go to "Shared Folders" settings in VirtualBox, add a share:

-Folder Path: C:\Users

-Folder Name: Users

-Auto-mount: <checked>

-Read-only: <unchecked>

-

-Install Ubuntu in the VM

-------------------------

-On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your Ubuntu ISO image.

-

-After selecting the ISO image, start the VM.

-Follow the prompts to install Ubuntu.

-

-Proxy Configuration (optional)

-------------------------------

-If you're behind a corporate firewall, configure some proxy settings.  NOTE: your proxy configuration may require username and password credentials, not shown here.

-**Ubuntu system proxy setting:**

-	System Settings → Network → Network proxy

-	(Replace "proxyhost" and port with your actual proxy information)

-

-**apt proxy setting:**

-	Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):

-		Acquire::http::Proxy "http://proxyhost:port";

-	Reboot the VM.

-	

-Install SSH Server

-------------------

-sudo apt update

-sudo apt install openssh-server

-

-Connect to the VM from your host computer

------------------------------------------

-	The PuTTY SSH client is popular.  A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.

-

-Install VirtualBox Guest Additions

-----------------------------------

-On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your VirtualBox Guest Additions ISO image.

-

-In a VM terminal window, mount the cdrom:

-	sudo mkdir -p /media/cdrom

-	sudo mount /dev/cdrom /media/cdrom

-Install necessary dependencies:

-	sudo apt update

-	sudo apt install gcc g++ dkms

-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.

-	cd /media/cdrom

-	sudo ./VBoxLinuxAdditions.run

-

-Add yourself to the vboxsf user group (replace "userid" with your user ID):

-	sudo usermod -a -G vboxsf userid

-Reboot the VM.

-In a VM terminal window, verify that you can access your home directory on the host computer, which should be mounted under here:

-	/media/sf_Users

-	

-Further Reading

-----------------------------------------	

-https://wiki.onap.org/display/DW/Development+Environment
\ No newline at end of file
+.. _open_cli_schema_version_1_0:
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+Install and Configure Service Orchestrator
+==========================================
+
+Get Ubuntu
+----------
+Get the Ubuntu ISO image from ubuntu.com. The recommended version is 16.04.3 LTS (Long Term Support), desktop edition.
+
+Get VirtualBox and VirtualBox Guest Additions
+---------------------------------------------
+Make sure you have the VirtualBox Guest Additions ISO for your version of
+VirtualBox.  I'm using VirtualBox 5.1.28.  Save the Guest Additions ISO on your
+host computer along with the Ubuntu ISO.  Get the Guest Additions ISO from
+here: http://download.virtualbox.org/virtualbox
+
+*NOTE*: Guest Additions versions prior to 5.1 will not work with Ubuntu 16.04.3.  If you have an earlier version of VirtualBox, you should upgrade to the latest 5.1 version.
+
+Create a new VM in VirtualBox for Ubuntu
+----------------------------------------
+Type: Linux
+Version: Ubuntu (64-bit)
+At least 2048 MB memory
+At least 40 GB VDI
+Network: Attached to: NAT
+
+Create a port-forwarding rule for SSH
+-------------------------------------
+Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.
+Go to "Network" settings in VirtualBox, add a port forwarding rule:
+Name: SSH
+Protocol: TCP
+Host IP: 127.0.0.1
+Host Port: 1022
+Guest IP: <leave blank>
+Guest Port: 22
+
+Create Shared Folder
+--------------------
+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.
+Go to "Shared Folders" settings in VirtualBox, add a share:
+Folder Path: C:\Users
+Folder Name: Users
+Auto-mount: <checked>
+Read-only: <unchecked>
+
+Install Ubuntu in the VM
+------------------------
+On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your Ubuntu ISO image.
+
+After selecting the ISO image, start the VM.
+Follow the prompts to install Ubuntu.
+
+Proxy Configuration (optional)
+------------------------------
+If you're behind a corporate firewall, configure some proxy settings.  NOTE: your proxy configuration may require username and password credentials, not shown here.
+**Ubuntu system proxy setting**:
+
+- System Settings → Network → Network proxy
+  (Replace "proxyhost" and port with your actual proxy information)
+
+**apt proxy setting**:
+
+- Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):
+  Acquire::http::Proxy "http://proxyhost:port";
+- Reboot the VM.
+
+Install SSH Server
+------------------
+sudo apt update
+sudo apt install openssh-server
+
+Connect to the VM from your host computer
+-----------------------------------------
+The PuTTY SSH client is popular.  A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.
+
+Install VirtualBox Guest Additions
+----------------------------------
+On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your VirtualBox Guest Additions ISO image.
+
+In a VM terminal window, mount the cdrom::
+
+  sudo mkdir -p /media/cdrom
+  sudo mount /dev/cdrom /media/cdrom
+
+Install necessary dependencies::
+
+  sudo apt update
+  sudo apt install gcc g++ dkms
+
+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.::
+
+  cd /media/cdrom
+  sudo ./VBoxLinuxAdditions.run
+
+Add yourself to the vboxsf user group (replace "userid" with your user ID)::
+
+  sudo usermod -a -G vboxsf userid
+
+Reboot the VM.
+In a VM terminal window, verify that you can access your home directory on the
+host computer, which should be mounted under /media/sf_Users
+
+Further Reading
+----------------------------------------
+https://wiki.onap.org/display/DW/Development+Environment