DOCS: Moved multiarch and build system, Incorprated Scott's changes
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb
Signed-off-by: John DeNisco <jdenisco@cisco.com>
diff --git a/docs/conf.py b/docs/conf.py
index 17b4b78..1d60e29 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -19,13 +19,13 @@
# -- Project information -----------------------------------------------------
project = u'Vector Packet Processor'
-copyright = u'2018, John DeNisco'
+copyright = u'2018, Linux Foundation'
author = u'John DeNisco'
# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
-release = u'0.1'
+release = u'1.0'
# -- General configuration ---------------------------------------------------
diff --git a/docs/gettingstarted/developers/building.rst b/docs/gettingstarted/developers/building.rst
index a408b51..15754b5 100644
--- a/docs/gettingstarted/developers/building.rst
+++ b/docs/gettingstarted/developers/building.rst
@@ -6,6 +6,7 @@
============
To get started developing with VPP you need to get the sources and build the packages.
+For more information on the build system please refer to :ref:`buildsystem`.
.. _setupproxies:
@@ -24,7 +25,7 @@
Get the VPP Sources
-----------------------------------
-To get the VPP sources and get ready to build execute the following:
+To get the VPP sources that are used to create the build, run the following commands:
.. code-block:: console
@@ -44,8 +45,9 @@
There should be no output, or packages showing after each of the above commands.
-Run these commands to install the dependencies for FD.io VPP.
-If it hangs during downloading at any point, you may need to set up :ref:`proxies for this to work <setupproxies>`.
+Run the following **make** command to install the dependencies for FD.io VPP.
+If it hangs at any point during the download, then you may need to set up
+:ref:`proxies for this to work <setupproxies>`.
.. code-block:: console
@@ -74,9 +76,9 @@
Build VPP (Debug)
----------------------------
-This build version contains debug symbols which is useful to modify VPP. The command
-below will build debug version of VPP. The binaries when building the debug images
-can be found in /build-root/vpp_debug-native.
+This build version contains debug symbols which are useful for modifying VPP. The
+**make** command below builds a debug version of VPP. The binaries, when building the
+debug images, can be found in /build-root/vpp_debug-native.
.. code-block:: console
@@ -105,6 +107,10 @@
To build the release version of FD.io VPP. This build is optimized and will not create debug symbols.
The binaries when building the release images can be found in /build-root/vpp-native.
+Use the following **make** command below to build the release version of FD.io VPP. This build is
+optimized and will not create debug symbols. When building the release images, the binaries can
+be found in /build-root/vpp-native.
+
.. code-block:: console
$ make build-release
@@ -113,19 +119,20 @@
Building Necessary Packages
--------------------------------------------
-To build the debian packages, one of the following commands below depending on the system:
-
Building Debian Packages
^^^^^^^^^^^^^^^^^^^^^^^^^
+To build the debian packages, use one of the following commands below, depending on the system:
+
.. code-block:: console
$ make pkg-deb
-
Building RPM Packages
^^^^^^^^^^^^^^^^^^^^^^^
+To build the rpm packages, use one of the following commands below, depending on the system:
+
.. code-block:: console
$ make pkg-rpm
diff --git a/docs/reference/buildsystem/buildrootmakefile.rst b/docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst
similarity index 100%
rename from docs/reference/buildsystem/buildrootmakefile.rst
rename to docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst
diff --git a/docs/reference/buildsystem/index.rst b/docs/gettingstarted/developers/buildsystem/index.rst
similarity index 61%
rename from docs/reference/buildsystem/index.rst
rename to docs/gettingstarted/developers/buildsystem/index.rst
index f7c512e..38ba972 100644
--- a/docs/reference/buildsystem/index.rst
+++ b/docs/gettingstarted/developers/buildsystem/index.rst
@@ -3,7 +3,7 @@
Build System
============
-This reference guide describes the vpp build system in detail
+This guide describes the vpp build system in detail.
.. toctree::
diff --git a/docs/reference/buildsystem/mainmakefile.md b/docs/gettingstarted/developers/buildsystem/mainmakefile.md
similarity index 100%
rename from docs/reference/buildsystem/mainmakefile.md
rename to docs/gettingstarted/developers/buildsystem/mainmakefile.md
diff --git a/docs/gettingstarted/developers/gdb_examples.rst b/docs/gettingstarted/developers/gdb_examples.rst
index b2ef65b..8ea34cb 100644
--- a/docs/gettingstarted/developers/gdb_examples.rst
+++ b/docs/gettingstarted/developers/gdb_examples.rst
@@ -10,7 +10,7 @@
Starting GDB
----------------------------
-Once at the gdb prompt VPP can be started with the following:
+Once at the gdb prompt, VPP can be started by isuuing the following commands:
.. code-block:: console
@@ -25,7 +25,7 @@
----------------------------
If you encounter issues when running VPP, such as VPP terminating due to a segfault
-or abort signal, you can run the VPP debug binary and then execute **backtrace** or **bt**.
+or abort signal, then you can run the VPP debug binary and then execute **backtrace** or **bt**.
.. code-block:: console
@@ -38,12 +38,12 @@
Get to the GDB prompt
---------------------------------------
-When running VPP is running get to the command prompt with CTRL-c.
+When VPP is running, you can get to the command prompt by entering CTRL-c.
Breakpoints
---------------------------------------
-When at the GDB prompt set a breakpoint like so:
+When at the GDB prompt, set a breakpoint by using the commands below:
.. code-block:: console
diff --git a/docs/gettingstarted/developers/gitreview.rst b/docs/gettingstarted/developers/gitreview.rst
index f727fb1..a9e1b02 100644
--- a/docs/gettingstarted/developers/gitreview.rst
+++ b/docs/gettingstarted/developers/gitreview.rst
@@ -57,20 +57,20 @@
$ git clone ssh://YOUR_GERRIT_USERNAME@gerrit.fd.io:29418/vpp
$ cd vpp
-When attempting to clone the repo it will ask if you want to add the Server Host Key to the list of known hosts. Type **yes** and hit enter.
+When attempting to clone the repo Git will prompt you asking if you want to add the Server Host Key to the list of known hosts. Enter **yes** and press the **Enter** key.
Git Review
===========
-The VPP documents use the gerrit server and git review for submitting and fetching patches.
+The VPP documents use the gerrit server, and git review for submitting and fetching patches.
New patch
-----------------
-When working with new patch use the following to get your patch reviewed.
+When working with a new patch, use the following commands to get your patch reviewed.
-Make sure you have modified the correct files with:
+Make sure you have modified the correct files by issuing the following commands:
.. code-block:: console
@@ -78,7 +78,7 @@
$ git diff
Then add and commit the patch. You may want to add a tag to the commit comments.
-For example for document only patches you should add the tag **DOCS:**.
+For example for a document with only patches you should add the tag **DOCS:**.
.. code-block:: console
diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
index 76feb05..8c39069 100644
--- a/docs/gettingstarted/developers/index.rst
+++ b/docs/gettingstarted/developers/index.rst
@@ -25,8 +25,10 @@
plugins
vnet
featurearcs
+ multiarch/index.rst
bihash
vpp_api_module
binary_api_support
+ buildsystem/index.rst
sample_plugin
diff --git a/docs/reference/multiarch/index.rst b/docs/gettingstarted/developers/multiarch/index.rst
similarity index 100%
rename from docs/reference/multiarch/index.rst
rename to docs/gettingstarted/developers/multiarch/index.rst
diff --git a/docs/reference/multiarch/nodefns.rst b/docs/gettingstarted/developers/multiarch/nodefns.rst
similarity index 100%
rename from docs/reference/multiarch/nodefns.rst
rename to docs/gettingstarted/developers/multiarch/nodefns.rst
diff --git a/docs/gettingstarted/developers/plugins.md b/docs/gettingstarted/developers/plugins.rst
similarity index 83%
rename from docs/gettingstarted/developers/plugins.md
rename to docs/gettingstarted/developers/plugins.rst
index ba3a244..d18a5a8 100644
--- a/docs/gettingstarted/developers/plugins.md
+++ b/docs/gettingstarted/developers/plugins.rst
@@ -1,3 +1,4 @@
+.. _dplugins:
Plugins
=======
@@ -9,3 +10,4 @@
Once loaded, the plug-in DLL mechanism uses dlsym to find and verify a
vlib\_plugin\_registration data structure in the newly-loaded plug-in.
+For more on plugins please refer to :ref:`sample_plugin`.
diff --git a/docs/gettingstarted/developers/running_vpp.rst b/docs/gettingstarted/developers/running_vpp.rst
index f0d56fb..a121576 100644
--- a/docs/gettingstarted/developers/running_vpp.rst
+++ b/docs/gettingstarted/developers/running_vpp.rst
@@ -5,13 +5,14 @@
Running VPP
===========
-After build the VPP binaries, there a several to run the images you've built. These is useful when
-if you need to run VPP without installing the packages. For instance if you want to run VPP with GDB.
+After building the VPP binaries, you now have several images that you have built.
+These images are useful when you need to run VPP without installing the packages.
+For instance if you want to run VPP with GDB.
-Without GDB
+Running Without GDB
_________________________
-To run the VPP images, that you've build without GDB.
+To run the VPP images that you've built without GDB, run the following commands:
Running the release image:
@@ -27,7 +28,7 @@
# make run
#
-With GDB
+Running With GDB
_________________________
With the following commands you can run VPP and then be dropped into the GDB prompt.
diff --git a/docs/gettingstarted/developers/sample_plugin.rst b/docs/gettingstarted/developers/sample_plugin.rst
index 0426606..33fea0b 100644
--- a/docs/gettingstarted/developers/sample_plugin.rst
+++ b/docs/gettingstarted/developers/sample_plugin.rst
@@ -1,9 +1,9 @@
.. _sample_plugin:
-.. toctree::
+Integrating a plugin
+=====================
-Integrating a complete plugin with VPP
-======================================
+.. toctree::
Overview
________
diff --git a/docs/gettingstarted/index.rst b/docs/gettingstarted/index.rst
index acee196..4fcc513 100644
--- a/docs/gettingstarted/index.rst
+++ b/docs/gettingstarted/index.rst
@@ -1,17 +1,20 @@
.. _gettingstarted:
######################
-Getting Started Guides
+Getting Started
######################
-The Getting Started Guide is comprised of several different sections; a section for Users, another for Developers, and a section for Writing VPP documentation.
+The Getting Started Guide is comprised of several different sections; a User section
+that describes a basic installation and configuration of VPP (either manually or using
+a config utility), another install for Developers, which contains additional code that
+provides tools that are used in a development environment.
-The Users section covers basic VPP installation and configuration operations. This section covers the following areas:
+The Users section covers basic VPP installation and configuration operations; this
+section covers the following areas:
-* Describes the different types of VPP packages
-* Describes how to install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE).
-* Explains how to configure, then use VPP.
-* Explains how to use the Configuration Utility.
+* Describes the different types of VPP packages, which are used in both basic and developer installs.
+* Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE) and then how to configure and use VPP.
+* Explains how to use the Configuration Utility to install, and then configure VPP.
The Developers section covers the following areas:
diff --git a/docs/gettingstarted/users/configuring/hugepages.rst b/docs/gettingstarted/users/configuring/hugepages.rst
index 76ac7d0..da812e3 100644
--- a/docs/gettingstarted/users/configuring/hugepages.rst
+++ b/docs/gettingstarted/users/configuring/hugepages.rst
@@ -3,13 +3,14 @@
Huge Pages
----------
-VPP requires *'hugepages'* to run. VPP will overwrite existing hugepage settings
-when VPP is installed. By default, VPP sets the number of hugepages on a system
-to 1024 2M hugepages (1G hugepages are no longer supported). This is the number
-of hugepages on the system, not just used by VPP.
+VPP requires *hugepages* to run during VPP operation, to manage large pages of memory.
+During VPP installation, VPP will overwrite the existing hugepage settings. By
+default, VPP sets the number of hugepages on a system to 1024 2M hugepages (1G hugepages
+are no longer supported). This is the number of hugepages on the system, not just used by VPP.
-When VPP is installed, the following file is copied to the system and used to apply the
-hugepage settings on VPP installation and system reboot:
+When VPP is installed, the following configuration file is copied to the system. The
+hugepage settings are applied in the VPP installation and on system reboots. To set
+the hugepage settings, perform the following commands:
.. code-block:: console
@@ -30,10 +31,10 @@
# to current shmmax value.
kernel.shmmax=2147483648
-Depending on how the system is being used, this file can be updated to adjust
+Depending on how the system is being used, this configuration file can be updated to adjust
the number of hugepages reserved on a system. Below are some examples of
-possible values.
-
+possible settings.
+
For a small VM with minimal workload:
.. code-block:: console
@@ -54,9 +55,9 @@
.. note::
If VPP is being run in a Virtual Machine (VM), the VM must have hugepage
- backing. When VPP is installed, it will attempt to overwrite existing
- hugepage setting. If the VM does not have hugepage backing, this will fail,
- but this may go unnoticed. When the VM is rebooted, on system startup,
- *'vm.nr_hugepages'* will be reapplied, will fail, and the VM will abort kernel
+ backing. When VPP is installed, it will attempt to overwrite existing the
+ hugepage setting. If the VM does not have hugepage backing, the install will fail,
+ but the failure may go unnoticed. When the VM is rebooted, on system startup,
+ *'vm.nr_hugepages'* will be reapplied, and will fail, and the VM will abort kernel
boot, locking up the VM. To avoid this scenario, ensure the VM has enough
hugepage backing.
diff --git a/docs/gettingstarted/users/configuring/index.rst b/docs/gettingstarted/users/configuring/index.rst
index f1244c6..0de77ad 100644
--- a/docs/gettingstarted/users/configuring/index.rst
+++ b/docs/gettingstarted/users/configuring/index.rst
@@ -3,8 +3,8 @@
Configuring VPP
==================
-There is some basic configuration that is needed to run FD.io VPP. This section
-describes the basic configuration:
+There is some basic configuration that needs to be performed before running
+FD.io VPP. This section describes the configuration process:
.. toctree::
:maxdepth: 2
diff --git a/docs/gettingstarted/users/index.rst b/docs/gettingstarted/users/index.rst
index 36640a8..7bac586 100644
--- a/docs/gettingstarted/users/index.rst
+++ b/docs/gettingstarted/users/index.rst
@@ -4,13 +4,19 @@
Users
########
+The Users section describe a basic VPP installation and configuration operation.
+The installation and configuration of VPP can be done either manually, or by
+using a configuration utility.
+
+This section covers the following areas:
+
The Users section covers basic VPP installation and configuration operations. This
section covers the following areas:
* Describes the different types of VPP packages
-* Describes how to install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE)
-* Explains how to configure, then use VPP
-* Explains how to use the Configuration Utility
+* Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE)
+* Explains how to manually configure, then run VPP
+* Explains how to install, then configure VPP using the Configuration Utility
.. toctree::
:maxdepth: 2
diff --git a/docs/gettingstarted/users/installing/centos.rst b/docs/gettingstarted/users/installing/centos.rst
index 470ca87..dae24f6 100644
--- a/docs/gettingstarted/users/installing/centos.rst
+++ b/docs/gettingstarted/users/installing/centos.rst
@@ -8,7 +8,8 @@
Update the OS
-------------
-Before starting the repository setup, it is a good idea to first update and upgrade the OS.
+Before starting the repository setup, it is a good idea to first update and upgrade
+the OS; run the following command to update the OS:
.. code-block:: console
@@ -18,8 +19,7 @@
Point to the Repository
-----------------------
-For CentOS based systems, there are two respositories to pull VPP binaries
-from.
+For CentOS based systems, there are two respositories to pull VPP binaries from:
* CentOS NFV SIG Repository
* Nexus Repository
@@ -28,15 +28,14 @@
CentOS NFV SIG Repository
^^^^^^^^^^^^^^^^^^^^^^^^^
-VPP is not in the official CentOS 7 distro. However, CentOS has Special
+VPP is not in the official CentOS 7 distro; however, CentOS has Special
Interest Groups (SIG), which are smaller groups within the CentOS community that
focus on a small set of issues. The CentOS NFV (Network Function Virtualization)
SIG was created to provide a CentOS-based stack that will serve as a platform
-for the deployment and testing of virtual network functions (VNFs). VPP has been
-included in this SIG.
To install released packages from the CentOS NFV SIG Repository on an updated
-Centos 7 system, first, install the CentOS NFV SIG FIDO repo file:
+Centos 7 system, first, install the CentOS NFV SIG FIDO repo file by running the
+following command:
.. code-block:: console
@@ -109,7 +108,7 @@
""""""""""""""""""
To allow *'yum'* access to the official VPP releases, create the file
-*'/etc/yum.repos.d/fdio-release.repo'* with the following content:
+*'/etc/yum.repos.d/fdio-release.repo'* with the following content.
.. code-block:: console
@@ -122,7 +121,7 @@
The *'yum install vpp'* command will install the most recent release. To
install older releases, run the following command to get the list of releases
-provided:
+provided.
.. code-block:: console
@@ -133,10 +132,10 @@
particular version of the RPMs.
VPP Stable Branch
-"""""""""""""""""
+"""""""""""""""""""
To allow *yum* access to the build artifacts for a VPP stable branch, create
-the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content:
+the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content.
.. code-block:: console
@@ -164,10 +163,10 @@
VPP Master Branch
-"""""""""""""""""
+"""""""""""""""""""
To allow *yum* access to the nightly builds from the VPP master branch, create
-the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content:
+the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content.
.. code-block:: console
@@ -180,7 +179,7 @@
The *'yum install vpp'* command will install the most recent build on the
branch. Run the following command to get the list of images produce by the
-branch:
+branch.
.. code-block:: console
@@ -194,18 +193,18 @@
Install VPP RPMs
================
-To install the VPP packet engine, run the following:
+To install the VPP packet engine, run the following command:
.. code-block:: console
$ sudo yum install vpp
-The **'vpp'** RPM depend on the **'vpp-lib'** and **'vpp-selinux-policy'**
+The *vpp* RPM depends on the *vpp-lib* and *vpp-selinux-policy*
RPMs, so they will be installed as well.
.. note::
- The **'vpp-selinux-policy'** will not enable SELinux on the system. It
+ The *vpp-selinux-policy* will not enable SELinux on the system. It
will install a Custom VPP SELinux policy that will be used if SELinux is
enabled at any time.
@@ -221,19 +220,18 @@
============
Once VPP is installed on the system, to run VPP as a systemd service on CentOS,
-run:
+run the following command:
.. code-block:: console
$ sudo systemctl start vpp
-Then to enable VPP to start on system reboot:
+Then to enable VPP to start on system reboot, run the following command:
.. code-block:: console
$ sudo systemctl enable vpp
-
Outside of running VPP as a systemd service, VPP can be started manually or
made to run within GDB for debugging. See :ref:`running` for more details and
ways to tailor VPP to a specific system.
@@ -242,6 +240,8 @@
Uninstall the VPP RPMs
======================
+To uninstall a VPP RPM, run the following command:
+
.. code-block:: console
$ sudo yum autoremove vpp*
diff --git a/docs/gettingstarted/users/installing/index.rst b/docs/gettingstarted/users/installing/index.rst
index 4a8ac7a..12a5ab8 100644
--- a/docs/gettingstarted/users/installing/index.rst
+++ b/docs/gettingstarted/users/installing/index.rst
@@ -12,16 +12,8 @@
.. toctree::
-Package Descriptions
---------------------
-The following is a brief description of the packages to be installed with VPP.
-
-.. toctree::
-
- packages
-
-Installing VPP Binaries
-----------------------------------
+Installing VPP
+---------------
This section provides directions on how to Install VPP binaries on Ubuntu, Centos,
and openSUSE platforms.
@@ -49,3 +41,11 @@
.. toctree::
opensuse
+
+Package Descriptions
+--------------------
+The following is a brief description of the packages to be installed with VPP.
+
+.. toctree::
+
+ packages
diff --git a/docs/gettingstarted/users/installing/opensuse.rst b/docs/gettingstarted/users/installing/opensuse.rst
index b5dcbc3..6d78738 100644
--- a/docs/gettingstarted/users/installing/opensuse.rst
+++ b/docs/gettingstarted/users/installing/opensuse.rst
@@ -4,8 +4,9 @@
Installing
==========
-To install VPP on openSUSE, first install the following release and then execute
-the appropriate commands.
+
+To install VPP on openSUSE, first install the following release, and then execute
+the associated commands.
openSUSE Tumbleweed (rolling release)
------------------------------------------------------------
@@ -25,6 +26,8 @@
Uninstall
=========
+To uninstall the vpp plugins, run the following command:
+
.. code-block:: console
sudo zypper remove -u vpp vpp-plugins
@@ -32,6 +35,8 @@
openSUSE Tumbleweed (rolling release)
-------------------------------------
+To uninstall the openSUSE Tumbleweed, run the following command:
+
.. code-block:: console
sudo zypper remove -u vpp vpp-plugins
diff --git a/docs/gettingstarted/users/installing/ubuntu.rst b/docs/gettingstarted/users/installing/ubuntu.rst
index 5b4a1d8..cb7a1c6 100644
--- a/docs/gettingstarted/users/installing/ubuntu.rst
+++ b/docs/gettingstarted/users/installing/ubuntu.rst
@@ -5,13 +5,13 @@
Ubuntu 16.04 - Setup the fd.io Repository
==========================================
-From the following, choose one of the releases to install.
+Choose one of the following releases to install.
Update the OS
-----------------------
-It is probably a good idea to update and upgrade the OS before starting
+It is a good idea to first update and upgrade the OS before starting; run the following command to update the OS:
.. code-block:: console
@@ -21,7 +21,7 @@
Point to the Repository
-----------------------------------
-Create a file **"/etc/apt/sources.list.d/99fd.io.list"** with the contents that point to
+Create a file **/etc/apt/sources.list.d/99fd.io.list** with contents that point to
the version needed. The contents needed are shown below.
.. _install_vpp:
@@ -29,7 +29,7 @@
VPP latest Release
^^^^^^^^^^^^^^^^^^^
-Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
+Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
.. code-block:: console
@@ -39,7 +39,7 @@
VPP stable/1804 Branch
^^^^^^^^^^^^^^^^^^^^^^^
-Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
+Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
.. code-block:: console
@@ -49,7 +49,7 @@
VPP master Branch
^^^^^^^^^^^^^^^^^^^^
-Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents:
+Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
.. code-block:: console
@@ -59,6 +59,8 @@
Install the Mandatory Packages
===============================
+Install the mandatory packages by running the following commands:
+
.. code-block:: console
sudo apt-get update
@@ -68,6 +70,8 @@
Install the Optional Packages
==============================
+Install the optional packages by running the following command:
+
.. code-block:: console
sudo apt-get install vpp-dbg vpp-dev vpp-api-java vpp-api-python vpp-api-lua
@@ -76,6 +80,8 @@
Uninstall the Packages
======================
+Uninstall the packages by running the following command:
+
.. code-block:: console
sudo apt-get remove --purge vpp*
diff --git a/docs/gettingstarted/writingdocs/index.rst b/docs/gettingstarted/writingdocs/index.rst
index c59a39d..45a746d 100644
--- a/docs/gettingstarted/writingdocs/index.rst
+++ b/docs/gettingstarted/writingdocs/index.rst
@@ -1,7 +1,7 @@
.. _writingdocs:
#########################
-VPP Documents
+Writing Documents
#########################
This section covers the following topics:
diff --git a/docs/index.rst b/docs/index.rst
index ae9276f..094ed95 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,8 +7,6 @@
FD.io VPP
#########
-This is beta VPP Documentation it is not meant to be complete or accurate yet!!!!
-
FD.io Vector Packet Processing (VPP) is a fast, scalable and multi-platform network stack.
FD.io VPP is, at it's core, a scalable layer 2-4 network stack.
diff --git a/docs/links/index.rst b/docs/links/index.rst
index 03b317f..f241df9 100644
--- a/docs/links/index.rst
+++ b/docs/links/index.rst
@@ -1,8 +1,8 @@
.. _links:
-#############
-Other Links
-#############
+#############################
+VPP Wiki and Other Links
+#############################
There are several places to find helpful Information regarding FD.io VPP.
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index 48b5170..23ddecd 100644
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -7,9 +7,7 @@
.. toctree::
:maxdepth: 2
+ vppvagrant/index.rst
readthedocs/index.rst
github/index.rst
- vppvagrant/index.rst
- buildsystem/index.rst
- multiarch/index.rst
cmdreference/index.rst