docs: Reformat docs to rel/b standard.
[ovsnfv.git] / docs / index.rst
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755 (executable)
index 0000000..4721498
--- /dev/null
@@ -0,0 +1,35 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+
+.. Open vSwitch for NFV Documentation master file.
+
+====================
+Open vSwitch for NFV
+====================
+Welcome to OVSNFV's documentation!
+
+OVSNFV is an OPNFV collaborative development project.
+
+The OVSNFV project proposes:
+
+* To modify the OPNFV build to include a deployment option for the
+  software-accelerated userspace Open vSwitch build. This change will
+  significantly improve the performance of the NFVI for network I/O.
+* Future work to encompass collaborative development within the Open
+  vSwitch project to improve the performance of the software-accelerated
+  userspace Open vSwitch and increasing its suitability for Telco NFV
+  deployments.
+
+.. toctree::
+   :maxdepth: 3
+   :numbered: 5
+
+   ./configguide/index.rst
+   ./userguide/index.rst
+
+
+Indices
+=======
+* :ref:`search`
+