docs/gettingstarted/index.rst

   1 .. _gettingstarted:
   2
   3 ######################
   4 Getting Started
   5 ######################
   6
   7 The Getting Started Guide is comprised of several different sections; a User section
   8 that describes a basic installation and configuration of VPP (either manually or using
   9 a config utility),  another install for Developers, which contains additional code that
  10 provides tools that are used in a development environment.
  11
  12 The Users section covers basic VPP installation and configuration operations; this
  13 section covers the following areas:
  14
  15 * Describes the different types of VPP packages, which are used in both basic and developer installs.
  16 * Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE) and then how to configure and use VPP.
  17 * Explains how to use the Configuration Utility to install, and then configure VPP.
  18
  19 The Developers section covers the following areas:
  20
  21 * Building VPP
  22 * Describes the components of the four VPP layers
  23 * How to Create, Add, Enable/Disable features
  24 * Discusses different aspects of Bounded-index Extensible Hashing (bihash)
  25
  26 The Writing VPP Documentation section covers the following topics:
  27
  28 * How to build VPP documents
  29 * How to push your changes to the VPP Docs Repository
  30 * Identifies the different styles associated to reStructuredText
  31 * Identifies the different styles associated to Markdown
  32
  33 .. toctree::
  34    :maxdepth: 2
  35
  36    users/index.rst
  37    developers/index.rst
  38    writingdocs/index.rst