docs/gettingstarted/index.rst

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