2018-07-26 12:45:10 -04:00
|
|
|
.. _gettingstarted:
|
|
|
|
|
|
2018-08-02 15:03:15 -04:00
|
|
|
######################
|
2018-08-14 16:04:09 -04:00
|
|
|
Getting Started
|
2018-08-02 15:03:15 -04:00
|
|
|
######################
|
|
|
|
|
|
2018-08-14 16:04:09 -04:00
|
|
|
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.
|
2018-08-02 15:03:15 -04:00
|
|
|
|
2018-08-14 16:04:09 -04:00
|
|
|
The Users section covers basic VPP installation and configuration operations; this
|
|
|
|
|
section covers the following areas:
|
2018-08-02 15:03:15 -04:00
|
|
|
|
2018-08-14 16:04:09 -04:00
|
|
|
* 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.
|
2018-08-02 15:03:15 -04:00
|
|
|
|
|
|
|
|
The Developers section covers the following areas:
|
|
|
|
|
|
|
|
|
|
* Building VPP
|
|
|
|
|
* Describes the components of the four VPP layers
|
|
|
|
|
* How to Create, Add, Enable/Disable features
|
|
|
|
|
* Discusses different aspects of Bounded-index Extensible Hashing (bihash)
|
|
|
|
|
|
|
|
|
|
The Writing VPP Documentation section covers the following topics:
|
|
|
|
|
|
|
|
|
|
* How to build VPP documents
|
|
|
|
|
* How to push your changes to the VPP Docs Repository
|
|
|
|
|
* Identifies the different styles associated to reStructuredText
|
|
|
|
|
* Identifies the different styles associated to Markdown
|
2018-07-26 12:45:10 -04:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2018-08-16 13:50:02 -04:00
|
|
|
progressivevpp/index.rst
|
2018-07-26 12:45:10 -04:00
|
|
|
users/index.rst
|
|
|
|
|
developers/index.rst
|
|
|
|
|
writingdocs/index.rst
|
