blob: acee1963af5d073ec96f3670649241e99dc1b72e [file] [log] [blame]
.. _gettingstarted:
######################
Getting Started Guides
######################
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 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.
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
.. toctree::
:maxdepth: 2
users/index.rst
developers/index.rst
writingdocs/index.rst