summaryrefslogtreecommitdiffstats
path: root/docs/release/userguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/userguide')
-rw-r--r--docs/release/userguide/feature.userguide.rst17
-rw-r--r--docs/release/userguide/index.rst24
2 files changed, 41 insertions, 0 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
new file mode 100644
index 0000000..5741f2d
--- /dev/null
+++ b/docs/release/userguide/feature.userguide.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Intel Corporation
+
+OVSNFV description
+=====================
+Open vSwtich (OVS) is a software switch commonly used in OPNFV deployments.
+OVSNFV project supplies a Fuel Plugin to upgrade DPDK enabled Open vSwitch on
+an OPNFV to 2.5.90.
+
+
+OVSNFV capabilities and usage
+================================
+After installation use of the scenario requires no further action by the user.
+Traffic on the private network will automatically be processed by the upgraded
+DPDK datapath.
+
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644
index 0000000..1566bf6
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Intel Corporation
+
+=================
+OVSNFV user guide
+=================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+
+.. toctree::
+ :maxdepth: 3
+
+ ./feature.userguide.rst
+
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+