From 497a0acff887dc0339b4ab9b79fded18a17ebe59 Mon Sep 17 00:00:00 2001 From: Billy O'Mahony Date: Tue, 9 Feb 2016 13:23:18 +0000 Subject: [PATCH] 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 Reviewed-by: Mark D. Gray Reviewed-by: Thomas F Herbert Reviewed-by: Michal Ptacek Reviewed-by: Chris Price (cherry picked from commit 124d429e97cb57c31735ba596900d6cab50d6458) --- docs/{userguides => configguide}/index.rst | 1 - docs/{userguides => configguide}/installation.rst | 0 docs/{all => }/index.rst | 11 ++++------- docs/userguide/index.rst | 13 +++++++++++++ docs/{userguides => userguide}/quickstart.rst | 0 5 files changed, 17 insertions(+), 8 deletions(-) rename docs/{userguides => configguide}/index.rst (95%) rename docs/{userguides => configguide}/installation.rst (100%) rename docs/{all => }/index.rst (73%) create mode 100644 docs/userguide/index.rst rename docs/{userguides => userguide}/quickstart.rst (100%) diff --git a/docs/userguides/index.rst b/docs/configguide/index.rst similarity index 95% rename from docs/userguides/index.rst rename to docs/configguide/index.rst index 6809c8e..6f84c19 100644 --- a/docs/userguides/index.rst +++ b/docs/configguide/index.rst @@ -10,5 +10,4 @@ OVSNFV Guides and Installation :numbered: :maxdepth: 3 - quickstart.rst installation.rst diff --git a/docs/userguides/installation.rst b/docs/configguide/installation.rst similarity index 100% rename from docs/userguides/installation.rst rename to docs/configguide/installation.rst diff --git a/docs/all/index.rst b/docs/index.rst similarity index 73% rename from docs/all/index.rst rename to docs/index.rst index f4b1738..4721498 100755 --- a/docs/all/index.rst +++ b/docs/index.rst @@ -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 index 0000000..c2f593d --- /dev/null +++ b/docs/userguide/index.rst @@ -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 diff --git a/docs/userguides/quickstart.rst b/docs/userguide/quickstart.rst similarity index 100% rename from docs/userguides/quickstart.rst rename to docs/userguide/quickstart.rst -- 2.16.6