docs: Add initial documentation
[ovsnfv.git] / docs / all / index.rst
diff --git a/docs/all/index.rst b/docs/all/index.rst
new file mode 100755 (executable)
index 0000000..7917dbc
--- /dev/null
@@ -0,0 +1,34 @@
+.. Open vSwitch for NFV Documentation master file.
+
+====================
+Open vSwitch for NFV
+====================
+Welcome to OVSNFV's documentation !
+
+.. _OVSNFV: https://wiki.opnfv.org/open_vswitch_for_nfv
+.. _REPO: https://opnfv.org/gerrit/ovsnfv
+
+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
+
+   http://artifacts.opnfv.org/ovsnfv/docs/userguides/index.html
+   http://artifacts.opnfv.org/ovsnfv/docs/release/index.html
+
+
+Indices
+=======
+* :ref:`search`
+