aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-08-17 14:25:15 -0400
committerDamjan Marion <dmarion@me.com>2018-08-17 19:40:10 +0000
commita5db42f366798034e464442c92a90529fc947f08 (patch)
treeae96e6b332a7f5585a94a4ae069511f9fe07add9 /docs/gettingstarted
parentbf21dc85053931bc597e0fab1112061aa60e986b (diff)
docs: Moved installing up a level, removed guides.
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted')
-rw-r--r--docs/gettingstarted/index.rst19
-rw-r--r--docs/gettingstarted/installing/centos.rst (renamed from docs/gettingstarted/users/installing/centos.rst)0
-rw-r--r--docs/gettingstarted/installing/index.rst (renamed from docs/gettingstarted/users/installing/index.rst)19
-rw-r--r--docs/gettingstarted/installing/opensuse.rst (renamed from docs/gettingstarted/users/installing/opensuse.rst)0
-rw-r--r--docs/gettingstarted/installing/packages.rst (renamed from docs/gettingstarted/users/installing/packages.rst)0
-rw-r--r--docs/gettingstarted/installing/ubuntu.rst (renamed from docs/gettingstarted/users/installing/ubuntu.rst)0
-rw-r--r--docs/gettingstarted/users/index.rst1
7 files changed, 21 insertions, 18 deletions
diff --git a/docs/gettingstarted/index.rst b/docs/gettingstarted/index.rst
index f29d17942e5..2efe372b4dc 100644
--- 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
index dae24f6b4c8..dae24f6b4c8 100644
--- a/docs/gettingstarted/users/installing/centos.rst
+++ b/docs/gettingstarted/installing/centos.rst
diff --git a/docs/gettingstarted/users/installing/index.rst b/docs/gettingstarted/installing/index.rst
index 12a5ab8e015..3615e6ff7c4 100644
--- 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
index 6d7873820dc..6d7873820dc 100644
--- a/docs/gettingstarted/users/installing/opensuse.rst
+++ b/docs/gettingstarted/installing/opensuse.rst
diff --git a/docs/gettingstarted/users/installing/packages.rst b/docs/gettingstarted/installing/packages.rst
index 55ddf05fdad..55ddf05fdad 100644
--- a/docs/gettingstarted/users/installing/packages.rst
+++ b/docs/gettingstarted/installing/packages.rst
diff --git a/docs/gettingstarted/users/installing/ubuntu.rst b/docs/gettingstarted/installing/ubuntu.rst
index d1daed14ddb..d1daed14ddb 100644
--- a/docs/gettingstarted/users/installing/ubuntu.rst
+++ b/docs/gettingstarted/installing/ubuntu.rst
diff --git a/docs/gettingstarted/users/index.rst b/docs/gettingstarted/users/index.rst
index 4ec261a9937..7fdb2829eb8 100644
--- 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