Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC

Change-Id: I1c8c20cf85aa46269c5bc369f17ab0020862ddc5
Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>

diff --git a/docs/design/index.rst b/docs/development/design/index.rst
similarity index 100%
rename from docs/design/index.rst
rename to docs/development/design/index.rst

diff --git a/docs/design/inspector-design-guideline.rst b/docs/development/design/inspector-design-guideline.rst
similarity index 100%
rename from docs/design/inspector-design-guideline.rst
rename to docs/development/design/inspector-design-guideline.rst

diff --git a/docs/design/notification-alarm-evaluator.rst b/docs/development/design/notification-alarm-evaluator.rst
similarity index 100%
rename from docs/design/notification-alarm-evaluator.rst
rename to docs/development/design/notification-alarm-evaluator.rst

diff --git a/docs/design/performance-profiler.rst b/docs/development/design/performance-profiler.rst
similarity index 100%
rename from docs/design/performance-profiler.rst
rename to docs/development/design/performance-profiler.rst

diff --git a/docs/design/port-data-plane-status.rst b/docs/development/design/port-data-plane-status.rst
similarity index 100%
rename from docs/design/port-data-plane-status.rst
rename to docs/development/design/port-data-plane-status.rst

diff --git a/docs/design/report-host-fault-to-update-server-state-immediately.rst b/docs/development/design/report-host-fault-to-update-server-state-immediately.rst
similarity index 100%
rename from docs/design/report-host-fault-to-update-server-state-immediately.rst
rename to docs/development/design/report-host-fault-to-update-server-state-immediately.rst

diff --git a/docs/design/rfe-port-status-update.rst b/docs/development/design/rfe-port-status-update.rst
similarity index 100%
rename from docs/design/rfe-port-status-update.rst
rename to docs/development/design/rfe-port-status-update.rst

diff --git a/docs/index.rst b/docs/development/index.rst
old mode 100755 (executable)
new mode 100644 (file)
similarity index 78%
rename from docs/index.rst
rename to docs/development/index.rst
index a834997..71974fe
--- a/docs/index.rst
+++ b/docs/development/index.rst
@@ -11,14 +11,11 @@ Doctor
    :maxdepth: 2
    :numbered:
 
-   ./installationprocedure/index.rst
    ./design/index.rst
-   ./manuals/index.rst
    ./requirements/index.rst
-   ./scenarios/index.rst
-   ./userguide/index.rst
+   ./manuals/index.rst
+   ./overview/functest_scenario/index.rst
 
 Indices
 =======
 * :ref:`search`
-

diff --git a/docs/manuals/get-valid-server-state.rst b/docs/development/manuals/get-valid-server-state.rst
similarity index 100%
rename from docs/manuals/get-valid-server-state.rst
rename to docs/development/manuals/get-valid-server-state.rst

diff --git a/docs/manuals/index.rst b/docs/development/manuals/index.rst
similarity index 100%
rename from docs/manuals/index.rst
rename to docs/development/manuals/index.rst

diff --git a/docs/manuals/mark-host-down_manual.rst b/docs/development/manuals/mark-host-down_manual.rst
similarity index 100%
rename from docs/manuals/mark-host-down_manual.rst
rename to docs/development/manuals/mark-host-down_manual.rst

diff --git a/docs/scenarios/functest/doctor-scenario-in-functest.rst b/docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst
similarity index 100%
rename from docs/scenarios/functest/doctor-scenario-in-functest.rst
rename to docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst

diff --git a/docs/scenarios/functest/images/LICENSE b/docs/development/overview/functest_scenario/images/LICENSE
similarity index 91%
rename from docs/scenarios/functest/images/LICENSE
rename to docs/development/overview/functest_scenario/images/LICENSE
index f2b47d2..21a2d03 100644 (file)
--- a/docs/scenarios/functest/images/LICENSE
+++ b/docs/development/overview/functest_scenario/images/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+Copyright 2017 Open Platform for NFV Project, Inc. and its contributors
 
 Open Platform for NFV Project Documentation License
 ===================================================

diff --git a/docs/scenarios/functest/images/figure-p1.png b/docs/development/overview/functest_scenario/images/figure-p1.png
similarity index 100%
rename from docs/scenarios/functest/images/figure-p1.png
rename to docs/development/overview/functest_scenario/images/figure-p1.png

diff --git a/docs/requirements/01-intro.rst b/docs/development/requirements/01-intro.rst
similarity index 100%
rename from docs/requirements/01-intro.rst
rename to docs/development/requirements/01-intro.rst

diff --git a/docs/requirements/02-use_cases.rst b/docs/development/requirements/02-use_cases.rst
similarity index 100%
rename from docs/requirements/02-use_cases.rst
rename to docs/development/requirements/02-use_cases.rst

diff --git a/docs/requirements/03-architecture.rst b/docs/development/requirements/03-architecture.rst
similarity index 100%
rename from docs/requirements/03-architecture.rst
rename to docs/development/requirements/03-architecture.rst

diff --git a/docs/requirements/04-gaps.rst b/docs/development/requirements/04-gaps.rst
similarity index 100%
rename from docs/requirements/04-gaps.rst
rename to docs/development/requirements/04-gaps.rst

diff --git a/docs/requirements/05-implementation.rst b/docs/development/requirements/05-implementation.rst
similarity index 100%
rename from docs/requirements/05-implementation.rst
rename to docs/development/requirements/05-implementation.rst

diff --git a/docs/requirements/06-summary.rst b/docs/development/requirements/06-summary.rst
similarity index 100%
rename from docs/requirements/06-summary.rst
rename to docs/development/requirements/06-summary.rst

diff --git a/docs/requirements/07-annex.rst b/docs/development/requirements/07-annex.rst
similarity index 100%
rename from docs/requirements/07-annex.rst
rename to docs/development/requirements/07-annex.rst

diff --git a/docs/requirements/99-references.rst b/docs/development/requirements/99-references.rst
similarity index 100%
rename from docs/requirements/99-references.rst
rename to docs/development/requirements/99-references.rst

diff --git a/docs/requirements/glossary.rst b/docs/development/requirements/glossary.rst
similarity index 100%
rename from docs/requirements/glossary.rst
rename to docs/development/requirements/glossary.rst

diff --git a/docs/requirements/images/LICENSE b/docs/development/requirements/images/LICENSE
similarity index 91%
rename from docs/requirements/images/LICENSE
rename to docs/development/requirements/images/LICENSE
index f2b47d2..21a2d03 100644 (file)
--- a/docs/requirements/images/LICENSE
+++ b/docs/development/requirements/images/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+Copyright 2017 Open Platform for NFV Project, Inc. and its contributors
 
 Open Platform for NFV Project Documentation License
 ===================================================

diff --git a/docs/requirements/images/figure1.png b/docs/development/requirements/images/figure1.png
similarity index 100%
rename from docs/requirements/images/figure1.png
rename to docs/development/requirements/images/figure1.png

diff --git a/docs/requirements/images/figure10.png b/docs/development/requirements/images/figure10.png
similarity index 100%
rename from docs/requirements/images/figure10.png
rename to docs/development/requirements/images/figure10.png

diff --git a/docs/requirements/images/figure11.png b/docs/development/requirements/images/figure11.png
similarity index 100%
rename from docs/requirements/images/figure11.png
rename to docs/development/requirements/images/figure11.png

diff --git a/docs/requirements/images/figure12.png b/docs/development/requirements/images/figure12.png
similarity index 100%
rename from docs/requirements/images/figure12.png
rename to docs/development/requirements/images/figure12.png

diff --git a/docs/requirements/images/figure13.png b/docs/development/requirements/images/figure13.png
similarity index 100%
rename from docs/requirements/images/figure13.png
rename to docs/development/requirements/images/figure13.png

diff --git a/docs/requirements/images/figure14.png b/docs/development/requirements/images/figure14.png
similarity index 100%
rename from docs/requirements/images/figure14.png
rename to docs/development/requirements/images/figure14.png

diff --git a/docs/requirements/images/figure2.png b/docs/development/requirements/images/figure2.png
similarity index 100%
rename from docs/requirements/images/figure2.png
rename to docs/development/requirements/images/figure2.png

diff --git a/docs/requirements/images/figure3.png b/docs/development/requirements/images/figure3.png
similarity index 100%
rename from docs/requirements/images/figure3.png
rename to docs/development/requirements/images/figure3.png

diff --git a/docs/requirements/images/figure4.png b/docs/development/requirements/images/figure4.png
similarity index 100%
rename from docs/requirements/images/figure4.png
rename to docs/development/requirements/images/figure4.png

diff --git a/docs/requirements/images/figure5a.png b/docs/development/requirements/images/figure5a.png
similarity index 100%
rename from docs/requirements/images/figure5a.png
rename to docs/development/requirements/images/figure5a.png

diff --git a/docs/requirements/images/figure5b.png b/docs/development/requirements/images/figure5b.png
similarity index 100%
rename from docs/requirements/images/figure5b.png
rename to docs/development/requirements/images/figure5b.png

diff --git a/docs/requirements/images/figure5c.png b/docs/development/requirements/images/figure5c.png
similarity index 100%
rename from docs/requirements/images/figure5c.png
rename to docs/development/requirements/images/figure5c.png

diff --git a/docs/requirements/images/figure6.png b/docs/development/requirements/images/figure6.png
similarity index 100%
rename from docs/requirements/images/figure6.png
rename to docs/development/requirements/images/figure6.png

diff --git a/docs/requirements/images/figure7.png b/docs/development/requirements/images/figure7.png
similarity index 100%
rename from docs/requirements/images/figure7.png
rename to docs/development/requirements/images/figure7.png

diff --git a/docs/requirements/images/figure8.png b/docs/development/requirements/images/figure8.png
similarity index 100%
rename from docs/requirements/images/figure8.png
rename to docs/development/requirements/images/figure8.png

diff --git a/docs/requirements/images/figure9.png b/docs/development/requirements/images/figure9.png
similarity index 100%
rename from docs/requirements/images/figure9.png
rename to docs/development/requirements/images/figure9.png

diff --git a/docs/requirements/index.rst b/docs/development/requirements/index.rst
similarity index 100%
rename from docs/requirements/index.rst
rename to docs/development/requirements/index.rst

diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst
similarity index 100%
rename from docs/installationprocedure/feature.configuration.rst
rename to docs/release/configguide/feature.configuration.rst

diff --git a/docs/installationprocedure/index.rst b/docs/release/configguide/index.rst
similarity index 72%
rename from docs/installationprocedure/index.rst
rename to docs/release/configguide/index.rst
index b74b91f..ad89030 100644 (file)
--- a/docs/installationprocedure/index.rst
+++ b/docs/release/configguide/index.rst
@@ -1,9 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-**************************
-Doctor Configuration Guide
-**************************
+*************************
+Doctor Installation Guide
+*************************
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/release/index.rst b/docs/release/index.rst
new file mode 100644 (file)
index 0000000..6b0b43c
--- /dev/null
+++ b/docs/release/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2017 OPNFV.
+
+
+======
+Doctor
+======
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   ./installation/index.rst
+   ./userguide/index.rst
+
+Indices
+=======
+* :ref:`search`

diff --git a/docs/scenarios/index.rst b/docs/release/installation/index.rst
similarity index 66%
rename from docs/scenarios/index.rst
rename to docs/release/installation/index.rst
index 3732e02..eff14e5 100644 (file)
--- a/docs/scenarios/index.rst
+++ b/docs/release/installation/index.rst
@@ -1,12 +1,12 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-===============
-Doctor scenario
-===============
+********************
+Doctor Release Notes
+********************
 
 .. toctree::
     :maxdepth: 2
     :numbered:
 
-   ./functest/doctor-scenario-in-functest.rst
+    releasenotes.rst

diff --git a/docs/releasenotes/releasenotes.rst b/docs/release/installation/releasenotes.rst
similarity index 100%
rename from docs/releasenotes/releasenotes.rst
rename to docs/release/installation/releasenotes.rst

diff --git a/docs/releasenotes/releasenotes_colorado.rst b/docs/release/installation/releasenotes_colorado.rst
similarity index 100%
rename from docs/releasenotes/releasenotes_colorado.rst
rename to docs/release/installation/releasenotes_colorado.rst

diff --git a/docs/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
similarity index 100%
rename from docs/userguide/feature.userguide.rst
rename to docs/release/userguide/feature.userguide.rst

diff --git a/docs/userguide/index.rst b/docs/release/userguide/index.rst
similarity index 100%
rename from docs/userguide/index.rst
rename to docs/release/userguide/index.rst

diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
deleted file mode 100644 (file)
index 6fa37f6..0000000
--- a/docs/releasenotes/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-**************************
-OPNFV Doctor Release Notes
-**************************
-
-.. toctree::
-
-    releasenotes.rst