| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 1 | .. _gettingstarted: |
| 2 | |
| John DeNisco | c64ba6d | 2018-08-02 15:03:15 -0400 | [diff] [blame] | 3 | ###################### |
| John DeNisco | ce96dda | 2018-08-14 16:04:09 -0400 | [diff] [blame] | 4 | Getting Started |
| John DeNisco | c64ba6d | 2018-08-02 15:03:15 -0400 | [diff] [blame] | 5 | ###################### |
| 6 | |
| John DeNisco | ce96dda | 2018-08-14 16:04:09 -0400 | [diff] [blame] | 7 | The Getting Started Guide is comprised of several different sections; a User section |
| John DeNisco | a5db42f | 2018-08-17 14:25:15 -0400 | [diff] [blame] | 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. |
| John DeNisco | c64ba6d | 2018-08-02 15:03:15 -0400 | [diff] [blame] | 11 | |
| John DeNisco | a5db42f | 2018-08-17 14:25:15 -0400 | [diff] [blame] | 12 | This section covers the following: |
| John DeNisco | c64ba6d | 2018-08-02 15:03:15 -0400 | [diff] [blame] | 13 | |
| John DeNisco | ce96dda | 2018-08-14 16:04:09 -0400 | [diff] [blame] | 14 | * Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE) and then how to configure and use VPP. |
| John DeNisco | a5db42f | 2018-08-17 14:25:15 -0400 | [diff] [blame] | 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. |
| John DeNisco | c64ba6d | 2018-08-02 15:03:15 -0400 | [diff] [blame] | 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 |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 36 | |
| 37 | .. toctree:: |
| 38 | :maxdepth: 2 |
| 39 | |
| John DeNisco | a5db42f | 2018-08-17 14:25:15 -0400 | [diff] [blame] | 40 | installing/index.rst |
| John DeNisco | c4c72d2 | 2018-08-16 13:50:02 -0400 | [diff] [blame] | 41 | progressivevpp/index.rst |
| John DeNisco | 06dcd45 | 2018-07-26 12:45:10 -0400 | [diff] [blame] | 42 | users/index.rst |
| 43 | developers/index.rst |
| 44 | writingdocs/index.rst |