From c64ba6dc6ab9e3b06feac1a86c2f59d7052609ce Mon Sep 17 00:00:00 2001
From: John DeNisco <jdenisco@cisco.com>
Date: Thu, 2 Aug 2018 15:03:15 -0400
Subject: docs: Incororate Scott's overall review
Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e
Signed-off-by: John DeNisco <jdenisco@cisco.com>
---
docs/gettingstarted/users/installing/centos.rst | 2 +-
docs/gettingstarted/users/installing/index.rst | 14 ++++++++------
docs/gettingstarted/users/installing/opensuse.rst | 7 ++++---
docs/gettingstarted/users/installing/packages.rst | 4 +++-
docs/gettingstarted/users/installing/ubuntu.rst | 18 +++++++++---------
5 files changed, 25 insertions(+), 20 deletions(-)
(limited to 'docs/gettingstarted/users/installing')
diff --git a/docs/gettingstarted/users/installing/centos.rst b/docs/gettingstarted/users/installing/centos.rst
index bb69eb9e797..470ca87be1f 100644
--- a/docs/gettingstarted/users/installing/centos.rst
+++ b/docs/gettingstarted/users/installing/centos.rst
@@ -8,7 +8,7 @@ Setup the fd.io Repository - Centos 7
Update the OS
-------------
-It is probably a good idea to update and upgrade the OS before starting:
+Before starting the repository setup, it is a good idea to first update and upgrade the OS.
.. code-block:: console
diff --git a/docs/gettingstarted/users/installing/index.rst b/docs/gettingstarted/users/installing/index.rst
index 7636ec875fd..6cadae0a314 100644
--- a/docs/gettingstarted/users/installing/index.rst
+++ b/docs/gettingstarted/users/installing/index.rst
@@ -3,11 +3,10 @@
.. toctree::
Installing VPP from Packages
-============================
+==============================
-If you are simply using vpp, it can be convenient to install the binaries from
-existing packages. This guide will describe how pull, install and run the VPP
-packages.
+If you want to use VPP it can be convenient to install the binaries from
+existing packages. This guide describes how to pull, install and run the VPP packages.
.. toctree::
@@ -20,10 +19,13 @@ The following is a brief description of the packages to be installed with VPP.
packages
Installing VPP Binaries
------------------------
+----------------------------------
+
+This section provides directions on how to Install VPP binaries on Ubuntu, Centos,
+and openSUSE platforms.
Installing on Ubuntu
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^
The following are instructions on how to install VPP on Ubuntu.
.. toctree::
diff --git a/docs/gettingstarted/users/installing/opensuse.rst b/docs/gettingstarted/users/installing/opensuse.rst
index 8e91ebd2f45..b5dcbc35820 100644
--- a/docs/gettingstarted/users/installing/opensuse.rst
+++ b/docs/gettingstarted/users/installing/opensuse.rst
@@ -4,17 +4,18 @@
Installing
==========
-Top install VPP on openSUSE first pick the following release and execute the appropriate commands.
+To install VPP on openSUSE, first install the following release and then execute
+the appropriate commands.
openSUSE Tumbleweed (rolling release)
--------------------------------------
+------------------------------------------------------------
.. code-block:: console
sudo zypper install vpp vpp-plugins
openSUSE Leap 42.3
-------------------
+--------------------------------
.. code-block:: console
diff --git a/docs/gettingstarted/users/installing/packages.rst b/docs/gettingstarted/users/installing/packages.rst
index d67ff605d99..55ddf05fdad 100644
--- a/docs/gettingstarted/users/installing/packages.rst
+++ b/docs/gettingstarted/users/installing/packages.rst
@@ -1,7 +1,9 @@
.. _packages:
Packages
-========
+==========
+
+This section identifies the different VPP packages and describes their contents.
.. toctree::
diff --git a/docs/gettingstarted/users/installing/ubuntu.rst b/docs/gettingstarted/users/installing/ubuntu.rst
index 9c082e667b0..5b4a1d86fee 100644
--- a/docs/gettingstarted/users/installing/ubuntu.rst
+++ b/docs/gettingstarted/users/installing/ubuntu.rst
@@ -3,13 +3,13 @@
.. toctree::
Ubuntu 16.04 - Setup the fd.io Repository
-=========================================
+==========================================
-From the following choose one of the releases to install.
+From the following, choose one of the releases to install.
Update the OS
--------------
+-----------------------
It is probably a good idea to update and upgrade the OS before starting
@@ -19,7 +19,7 @@ It is probably a good idea to update and upgrade the OS before starting
Point to the Repository
------------------------
+-----------------------------------
Create a file **"/etc/apt/sources.list.d/99fd.io.list"** with the contents that point to
the version needed. The contents needed are shown below.
@@ -27,7 +27,7 @@ the version needed. The contents needed are shown below.
.. _install_vpp:
VPP latest Release
-^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^
Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
@@ -37,7 +37,7 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
VPP stable/1804 Branch
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^
Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
@@ -47,7 +47,7 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
VPP master Branch
-^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^
Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
@@ -57,7 +57,7 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
Install the Mandatory Packages
-==============================
+===============================
.. code-block:: console
@@ -66,7 +66,7 @@ Install the Mandatory Packages
Install the Optional Packages
-=============================
+==============================
.. code-block:: console
--
cgit