docs: Add version and build date
[vpp.git] / docs / index.rst
1 .. fdio-firstcut documentation master file, created by
2    sphinx-quickstart on Thu Apr 12 11:02:31 2018.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6 #########
7 FD.io VPP
8 #########
9
10 FD.io Vector Packet Processing (VPP) is a fast, scalable and multi-platform network stack. 
11
12 FD.io VPP is, at it's core, a scalable layer 2-4 network stack. 
13 It supports integration into both Open Stack and Kubernetes environments. 
14 It supports network management features including configuration, counters and sampling. 
15 It supports extending with plugins, tracing and debugging. 
16 It supports use cases such as vSwitch, vRouter, Gateways, Firewalls and Load Balancers, to name but a few. 
17 Finally it is useful both a software development kit or an appliance out of the box. 
18
19 .. toctree::
20    :maxdepth: 2
21
22    overview/index
23    gettingstarted/index
24    links/index
25    usecases/index
26    featuresbyrelease/index
27    troubleshooting/index
28    events/index
29    reference/index
30    relatedprojects/index
31    archive/index
32    about.rst