docs: Reformat docs to rel/b standard. 19/9819/1
authorBilly O'Mahony <billy.o.mahony@intel.com>
Tue, 9 Feb 2016 13:23:18 +0000 (13:23 +0000)
committerBilly O'Mahony <billy.o.mahony@intel.com>
Thu, 11 Feb 2016 17:46:21 +0000 (17:46 +0000)
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)

docs/configguide/index.rst [moved from docs/userguides/index.rst with 95% similarity]
docs/configguide/installation.rst [moved from docs/userguides/installation.rst with 100% similarity]
docs/index.rst [moved from docs/all/index.rst with 73% similarity]
docs/userguide/index.rst [new file with mode: 0644]
docs/userguide/quickstart.rst [moved from docs/userguides/quickstart.rst with 100% similarity]

similarity index 95%
rename from docs/userguides/index.rst
rename to docs/configguide/index.rst
index 6809c8e..6f84c19 100644 (file)
@@ -10,5 +10,4 @@ OVSNFV Guides and Installation
    :numbered:
    :maxdepth: 3
 
-   quickstart.rst
    installation.rst
similarity index 73%
rename from docs/all/index.rst
rename to docs/index.rst
index f4b1738..4721498 100755 (executable)
@@ -7,12 +7,9 @@
 ====================
 Open vSwitch for NFV
 ====================
-Welcome to OVSNFV's documentation !
+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.
+OVSNFV is an OPNFV collaborative development project.
 
 The OVSNFV project proposes:
 
@@ -28,8 +25,8 @@ The OVSNFV project proposes:
    :maxdepth: 3
    :numbered: 5
 
-   http://artifacts.opnfv.org/ovsnfv/docs/userguides/index.html
-   http://artifacts.opnfv.org/ovsnfv/docs/release/index.html
+   ./configguide/index.rst
+   ./userguide/index.rst
 
 
 Indices
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644 (file)
index 0000000..c2f593d
--- /dev/null
@@ -0,0 +1,13 @@
+.. 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
+
+******************************
+OVSNFV Guides and Installation
+******************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   quickstart.rst