9ad39c026c
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
39 lines
878 B
ReStructuredText
39 lines
878 B
ReStructuredText
.. _installing:
|
|
|
|
.. toctree::
|
|
|
|
.. _installingVPP:
|
|
|
|
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.
|
|
|
|
This section provides directions on how to Install VPP binaries on
|
|
Ubuntu, and Centos platforms.
|
|
|
|
FD.io VPP is installed using Package Cloud. For a complete set of
|
|
instructions on how to install VPP with package cloud please refer
|
|
to `Package Cloud <https://packagecloud.io/fdio/release>`_.
|
|
|
|
|
|
Installing on Ubuntu
|
|
---------------------------------
|
|
|
|
The following are instructions on how to install VPP on Ubuntu.
|
|
|
|
.. toctree::
|
|
|
|
ubuntu
|
|
|
|
|
|
Package Descriptions
|
|
----------------------------------
|
|
|
|
The following is a brief description of the packages to be installed with VPP.
|
|
|
|
.. toctree::
|
|
|
|
packages
|