docs: Moved installing up a level, removed guides.

Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b
Signed-off-by: John DeNisco <jdenisco@cisco.com>

diff --git a/docs/gettingstarted/index.rst b/docs/gettingstarted/index.rst
index f29d179..2efe372 100644 (file)
--- a/docs/gettingstarted/index.rst
+++ b/docs/gettingstarted/index.rst
@@ -5,16 +5,20 @@ Getting Started
 ######################
 
 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.
+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:
+This section covers the following:
 
-* 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.
+* Describes the different types of VPP packages, which are used in both basic and developer installs.
+* A VPP tutorial which is a great way to learn VPP basics.
+
+The Users section covers configuration operations; this
+
+* How to configure and Run VPP manually.
+* How to use the Configuration Utility to install, and then configure VPP.
 
 The Developers section covers the following areas:
 
@@ -33,6 +37,7 @@ The Writing VPP Documentation section covers the following topics:
 .. toctree::
    :maxdepth: 2
 
+   installing/index.rst
    progressivevpp/index.rst
    users/index.rst
    developers/index.rst

diff --git a/docs/gettingstarted/users/installing/centos.rst b/docs/gettingstarted/installing/centos.rst
similarity index 100%
rename from docs/gettingstarted/users/installing/centos.rst
rename to docs/gettingstarted/installing/centos.rst

diff --git a/docs/gettingstarted/users/installing/index.rst b/docs/gettingstarted/installing/index.rst
similarity index 82%
rename from docs/gettingstarted/users/installing/index.rst
rename to docs/gettingstarted/installing/index.rst
index 12a5ab8..3615e6f 100644 (file)
--- a/docs/gettingstarted/users/installing/index.rst
+++ b/docs/gettingstarted/installing/index.rst
@@ -4,22 +4,18 @@
 
 .. _installingVPP:
 
-Installing VPP from Packages
+Downloading and Installing VPP
 ==============================
 
 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::
-
-Installing VPP
----------------
-
 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::
@@ -27,7 +23,8 @@ The following are instructions on how to install VPP on Ubuntu.
    ubuntu
 
 Installing on Centos
-^^^^^^^^^^^^^^^^^^^^
+-------------------------------
+
 The following are instructions on how to install VPP on Centos.
 
 .. toctree::
@@ -35,7 +32,8 @@ The following are instructions on how to install VPP on Centos.
    centos
 
 Installing on openSUSE
-^^^^^^^^^^^^^^^^^^^^^^
+--------------------------------------
+
 The following are instructions on how to install VPP on openSUSE.
 
 .. toctree::
@@ -43,7 +41,8 @@ The following are instructions on how to install VPP on openSUSE.
    opensuse
 
 Package Descriptions
---------------------
+----------------------------------
+
 The following is a brief description of the packages to be installed with VPP.
 
 .. toctree::

diff --git a/docs/gettingstarted/users/installing/opensuse.rst b/docs/gettingstarted/installing/opensuse.rst
similarity index 100%
rename from docs/gettingstarted/users/installing/opensuse.rst
rename to docs/gettingstarted/installing/opensuse.rst

diff --git a/docs/gettingstarted/users/installing/packages.rst b/docs/gettingstarted/installing/packages.rst
similarity index 100%
rename from docs/gettingstarted/users/installing/packages.rst
rename to docs/gettingstarted/installing/packages.rst

diff --git a/docs/gettingstarted/users/installing/ubuntu.rst b/docs/gettingstarted/installing/ubuntu.rst
similarity index 100%
rename from docs/gettingstarted/users/installing/ubuntu.rst
rename to docs/gettingstarted/installing/ubuntu.rst

diff --git a/docs/gettingstarted/users/index.rst b/docs/gettingstarted/users/index.rst
index 4ec261a..7fdb282 100644 (file)
--- a/docs/gettingstarted/users/index.rst
+++ b/docs/gettingstarted/users/index.rst
@@ -22,6 +22,5 @@ section covers the following areas:
    :maxdepth: 2
 
    configutil/index.rst
-   installing/index.rst
    configuring/index.rst
    running/index.rst

diff --git a/docs/guides/api/index.rst b/docs/guides/api/index.rst
deleted file mode 100644 (file)
index d410d4a..0000000
--- a/docs/guides/api/index.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-.. _api:
-
-.. toctree::
-
-
-API User Guides
-===============
-
-This chapter describes how to use the C, Python and java APIs.
-
-.. _jvppjar:
-
-Downloading the jvpp jar
-------------------------
-The following are instructions on how to download the jvpp jar
-
-.. toctree::
-
-   jvpp

diff --git a/docs/guides/index.rst b/docs/guides/index.rst
deleted file mode 100644 (file)
index ab73368..0000000
--- a/docs/guides/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. _guides:
-
-=========================================
-User Guides
-=========================================
-
-.. toctree::
-   :maxdepth: 2
-
-   api/index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 094ed95..1488448 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -24,6 +24,5 @@ Finally it is useful both a software development kit or an appliance out of the
    links/index
    usecases/index
    troubleshooting/index
-   guides/index
    events/index
    reference/index

diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index 23ddecd..521caed 100644 (file)
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -8,6 +8,7 @@ Reference
    :maxdepth: 2
 
    vppvagrant/index.rst
+   jvpp.rst
    readthedocs/index.rst
    github/index.rst
    cmdreference/index.rst

diff --git a/docs/guides/api/jvpp.rst b/docs/reference/jvpp.rst
similarity index 95%
rename from docs/guides/api/jvpp.rst
rename to docs/reference/jvpp.rst
index 4c5c582..7dab487 100644 (file)
--- a/docs/guides/api/jvpp.rst
+++ b/docs/reference/jvpp.rst
@@ -3,13 +3,14 @@
 .. toctree::
 
 Getting jvpp jar
--------------------
+================
+
 VPP provides java bindings which can be downloaded at:
 
 * https://nexus.fd.io/content/repositories/fd.io.release/io/fd/vpp/jvpp-core/18.01/jvpp-core-18.01.jar
 
 Getting jvpp via maven
--------------------------
+------------------------------------
 
 **1. Add the following to the repositories section in your ~/.m2/settings.xml to pick up the fd.io maven repo:**
 

diff --git a/docs/usecases/index.rst b/docs/usecases/index.rst
index 523dffa..3507c2a 100644 (file)
--- a/docs/usecases/index.rst
+++ b/docs/usecases/index.rst
@@ -12,4 +12,3 @@ extensive list, but should give a sampling of the many features contained in FD.
    containers
    vhost/index.rst
    homegateway
-   uc_vSwitchvRouter

diff --git a/docs/usecases/uc_vSwitchvRouter.rst b/docs/usecases/uc_vSwitchvRouter.rst
deleted file mode 100644 (file)
index ace67ec..0000000
--- a/docs/usecases/uc_vSwitchvRouter.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-.. _vswitch:
-
-.. toctree::
-
-.. _vswitchrtr:
-
-vSwitch/vRouter
-===============
-
-
-FD.io VPP as a vSwitch/vRouter
-------------------------------
-
-.. note::
-
-   We need to provide commands and and show how to use VPP as a vSwitch/vRouter
-
-One of the use cases for the FD.io VPP platform is to implement it as a
-virtual switch or router. The following section describes examples of
-possible implementations that can be created with the FD.io VPP platform. For
-more in depth descriptions about other possible use cases, see the list
-of 
-
-.. figure:: /_images/VPP_App_as_a_vSwitch_x201.jpg
-   :alt: Figure: Linux host as a vSwitch
-   :align: right
-
-   Figure: Linux host as a vSwitch
-
-You can use the FD.io VPP platform to create out-of-the-box virtual switches
-(vSwitch) and virtual routers (vRouter). The FD.io VPP platform allows you to
-manage certain functions and configurations of these application through
-a command-line interface (CLI).
-
-Some of the functionality that a switching application can create
-includes:
-
-* Bridge Domains
-* Ports (including tunnel ports)
-* Connect ports to bridge domains
-* Program ARP termination
-
-Some of the functionality that a routing application can create
-includes:
-
-* Virtual Routing and Forwarding (VRF) tables (in the thousands)
-* Routes (in the millions)