diff options
| author |   John DeNisco <jdenisco@cisco.com> | 2018-07-26 12:45:10 -0400 |
|---|---|---|
| committer |   Dave Barach <openvpp@barachs.net> | 2018-07-26 18:34:47 +0000 |
| commit | 06dcd45ff81e06bc8cf40ed487c0b2652d346a5a (patch) | |
| tree | 71403f9d422c4e532b2871a66ab909bd6066b10b /docs/index.rst | |
| parent | 1d65279ffecd0f540288187b94cb1a6b84a7a0c6 (diff) | |
Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000000..5a9ddc3288f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,30 @@ +.. fdio-firstcut documentation master file, created by + sphinx-quickstart on Thu Apr 12 11:02:31 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +######### +FD.io VPP +######### + +This is beta VPP Documentation it is not meant to be complete or accurate yet!!!! + +FD.io Vector Packet Processing (VPP) is a fast, scalable and multi-platform network stack. + +FD.io VPP is, at it's core, a scalable layer 2-4 network stack. +It supports integration into both Open Stack and Kubernetes environments. +It supports network management features including configuration, counters and sampling. +It supports extending with plugins, tracing and debugging. +It supports use cases such as vSwitch, vRouter, Gateways, Firewalls and Load Balancers, to name but a few. +Finally it is useful both a software development kit or an appliance out of the box. + +.. toctree:: + :maxdepth: 2 + + overview/index + gettingstarted/index + usecases/index + troubleshooting/index + guides/index + events/index + reference/index |