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
   9 using a config utility),  another install for Developers, which contains additional
  10 code that provides tools that are used in a development environment.
  11
  12 This section covers the following:
  13
  14 * Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos) and then how to configure and use VPP.
  15 * Describes the different types of VPP packages, which are used in both basic and developer installs.
  16 * A VPP tutorial which is a great way to learn VPP basics.
  17
  18 The Users section covers configuration operations; this
  19
  20 * How to configure and Run VPP manually.
  21 * How to use the Configuration Utility to install, and then configure VPP.
  22
  23 The Developers section covers the following areas:
  24
  25 * Building VPP
  26 * Describes the components of the four VPP layers
  27 * How to Create, Add, Enable/Disable features
  28 * Discusses different aspects of Bounded-index Extensible Hashing (bihash)
  29
  30 The Writing VPP Documentation section covers the following topics:
  31
  32 * How to build VPP documents
  33 * How to push your changes to the VPP Docs Repository
  34 * Identifies the different styles associated to reStructuredText
  35 * Identifies the different styles associated to Markdown
  36
  37 .. toctree::
  38    :maxdepth: 2
  39
  40    installing/index.rst
  41    progressivevpp/index.rst
  42    users/index.rst
  43    developers/index.rst
  44    writingdocs/index.rst