Initial commit of Sphinx docs

[vpp.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..5a9ddc3
--- /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