diff options
| author |   Billy O'Mahony <billy.o.mahony@intel.com> | 2016-02-09 13:23:18 +0000 |
|---|---|---|
| committer | Billy O'Mahony <billy.o.mahony@intel.com> | 2016-02-11 17:46:21 +0000 |
| commit | 497a0acff887dc0339b4ab9b79fded18a17ebe59 (patch) | |
| tree | ed6e7da94de4d6256b0d52d44d837447f3140e6f /docs/index.rst | |
| parent | c733bde73da5913ce1560f5c74cc5aa846265789 (diff) | |
docs: Reformat docs to rel/b standard.
This patch is only to comply with https://wiki.opnfv.org/documentation
any other documention short-comings should be dealt with in a further
patch.
Change-Id: Ib770c192f9ad60907b923c9d99fa351d7621c7f2
Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Reviewed-by: Mark D. Gray <mark.d.gray@intel.com>
Reviewed-by: Thomas F Herbert <therbert@redhat.com>
Reviewed-by: Michal Ptacek <michalx.ptacek@intel.com>
Reviewed-by: Chris Price <christopher.price@ericsson.com>
(cherry picked from commit 124d429e97cb57c31735ba596900d6cab50d6458)
Diffstat (limited to 'docs/index.rst')
| -rwxr-xr-x | docs/index.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100755 index 0000000..4721498 --- /dev/null +++ b/docs/index.rst @@ -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` + |