summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGerald Kunzmann <kunzmann@docomolab-euro.com>2017-02-14 15:38:29 +0000
committerGerald Kunzmann <kunzmann@docomolab-euro.com>2017-02-16 14:41:46 +0000
commitd0b22e1d856cf8f78e152dfb6c150e001e03dd52 (patch)
tree0c3b7af828967d5014c2272675560410fceb6e4d /docs
parente171b396ce87322f2dc5ef0719419144774e43d7 (diff)
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>
Diffstat (limited to 'docs')
-rw-r--r--docs/development/design/index.rst (renamed from docs/design/index.rst)0
-rw-r--r--docs/development/design/inspector-design-guideline.rst (renamed from docs/design/inspector-design-guideline.rst)0
-rw-r--r--docs/development/design/notification-alarm-evaluator.rst (renamed from docs/design/notification-alarm-evaluator.rst)0
-rw-r--r--docs/development/design/performance-profiler.rst (renamed from docs/design/performance-profiler.rst)0
-rw-r--r--docs/development/design/port-data-plane-status.rst (renamed from docs/design/port-data-plane-status.rst)0
-rw-r--r--docs/development/design/report-host-fault-to-update-server-state-immediately.rst (renamed from docs/design/report-host-fault-to-update-server-state-immediately.rst)0
-rw-r--r--docs/development/design/rfe-port-status-update.rst (renamed from docs/design/rfe-port-status-update.rst)0
-rw-r--r--[-rwxr-xr-x]docs/development/index.rst (renamed from docs/index.rst)7
-rw-r--r--docs/development/manuals/get-valid-server-state.rst (renamed from docs/manuals/get-valid-server-state.rst)0
-rw-r--r--docs/development/manuals/index.rst (renamed from docs/manuals/index.rst)0
-rw-r--r--docs/development/manuals/mark-host-down_manual.rst (renamed from docs/manuals/mark-host-down_manual.rst)0
-rw-r--r--docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst (renamed from docs/scenarios/functest/doctor-scenario-in-functest.rst)0
-rw-r--r--docs/development/overview/functest_scenario/images/LICENSE (renamed from docs/scenarios/functest/images/LICENSE)2
-rwxr-xr-xdocs/development/overview/functest_scenario/images/figure-p1.png (renamed from docs/scenarios/functest/images/figure-p1.png)bin60756 -> 60756 bytes
-rw-r--r--docs/development/requirements/01-intro.rst (renamed from docs/requirements/01-intro.rst)0
-rw-r--r--docs/development/requirements/02-use_cases.rst (renamed from docs/requirements/02-use_cases.rst)0
-rw-r--r--docs/development/requirements/03-architecture.rst (renamed from docs/requirements/03-architecture.rst)0
-rw-r--r--docs/development/requirements/04-gaps.rst (renamed from docs/requirements/04-gaps.rst)0
-rw-r--r--docs/development/requirements/05-implementation.rst (renamed from docs/requirements/05-implementation.rst)0
-rw-r--r--docs/development/requirements/06-summary.rst (renamed from docs/requirements/06-summary.rst)0
-rw-r--r--docs/development/requirements/07-annex.rst (renamed from docs/requirements/07-annex.rst)0
-rw-r--r--docs/development/requirements/99-references.rst (renamed from docs/requirements/99-references.rst)0
-rw-r--r--docs/development/requirements/glossary.rst (renamed from docs/requirements/glossary.rst)0
-rw-r--r--docs/development/requirements/images/LICENSE (renamed from docs/requirements/images/LICENSE)2
-rw-r--r--docs/development/requirements/images/figure1.png (renamed from docs/requirements/images/figure1.png)bin79420 -> 79420 bytes
-rwxr-xr-xdocs/development/requirements/images/figure10.png (renamed from docs/requirements/images/figure10.png)bin422212 -> 422212 bytes
-rwxr-xr-xdocs/development/requirements/images/figure11.png (renamed from docs/requirements/images/figure11.png)bin355225 -> 355225 bytes
-rwxr-xr-xdocs/development/requirements/images/figure12.png (renamed from docs/requirements/images/figure12.png)bin2144916 -> 2144916 bytes
-rwxr-xr-xdocs/development/requirements/images/figure13.png (renamed from docs/requirements/images/figure13.png)bin646427 -> 646427 bytes
-rwxr-xr-xdocs/development/requirements/images/figure14.png (renamed from docs/requirements/images/figure14.png)bin578986 -> 578986 bytes
-rw-r--r--docs/development/requirements/images/figure2.png (renamed from docs/requirements/images/figure2.png)bin82010 -> 82010 bytes
-rwxr-xr-xdocs/development/requirements/images/figure3.png (renamed from docs/requirements/images/figure3.png)bin308234 -> 308234 bytes
-rwxr-xr-xdocs/development/requirements/images/figure4.png (renamed from docs/requirements/images/figure4.png)bin186805 -> 186805 bytes
-rwxr-xr-xdocs/development/requirements/images/figure5a.png (renamed from docs/requirements/images/figure5a.png)bin43787 -> 43787 bytes
-rwxr-xr-xdocs/development/requirements/images/figure5b.png (renamed from docs/requirements/images/figure5b.png)bin45067 -> 45067 bytes
-rwxr-xr-xdocs/development/requirements/images/figure5c.png (renamed from docs/requirements/images/figure5c.png)bin44400 -> 44400 bytes
-rwxr-xr-xdocs/development/requirements/images/figure6.png (renamed from docs/requirements/images/figure6.png)bin425612 -> 425612 bytes
-rwxr-xr-xdocs/development/requirements/images/figure7.png (renamed from docs/requirements/images/figure7.png)bin315053 -> 315053 bytes
-rwxr-xr-xdocs/development/requirements/images/figure8.png (renamed from docs/requirements/images/figure8.png)bin464430 -> 464430 bytes
-rwxr-xr-xdocs/development/requirements/images/figure9.png (renamed from docs/requirements/images/figure9.png)bin459353 -> 459353 bytes
-rw-r--r--docs/development/requirements/index.rst (renamed from docs/requirements/index.rst)0
-rw-r--r--docs/release/configguide/feature.configuration.rst (renamed from docs/installationprocedure/feature.configuration.rst)0
-rw-r--r--docs/release/configguide/index.rst (renamed from docs/installationprocedure/index.rst)6
-rw-r--r--docs/release/index.rst19
-rw-r--r--docs/release/installation/index.rst (renamed from docs/scenarios/index.rst)8
-rw-r--r--docs/release/installation/releasenotes.rst (renamed from docs/releasenotes/releasenotes.rst)0
-rw-r--r--docs/release/installation/releasenotes_colorado.rst (renamed from docs/releasenotes/releasenotes_colorado.rst)0
-rw-r--r--docs/release/userguide/feature.userguide.rst (renamed from docs/userguide/feature.userguide.rst)0
-rw-r--r--docs/release/userguide/index.rst (renamed from docs/userguide/index.rst)0
-rw-r--r--docs/releasenotes/index.rst10
50 files changed, 30 insertions, 24 deletions
diff --git a/docs/design/index.rst b/docs/development/design/index.rst
index 963002a0..963002a0 100644
--- a/docs/design/index.rst
+++ b/docs/development/design/index.rst
diff --git a/docs/design/inspector-design-guideline.rst b/docs/development/design/inspector-design-guideline.rst
index 4add8c0f..4add8c0f 100644
--- a/docs/design/inspector-design-guideline.rst
+++ b/docs/development/design/inspector-design-guideline.rst
diff --git a/docs/design/notification-alarm-evaluator.rst b/docs/development/design/notification-alarm-evaluator.rst
index d1bf787a..d1bf787a 100644
--- a/docs/design/notification-alarm-evaluator.rst
+++ b/docs/development/design/notification-alarm-evaluator.rst
diff --git a/docs/design/performance-profiler.rst b/docs/development/design/performance-profiler.rst
index f834a915..f834a915 100644
--- a/docs/design/performance-profiler.rst
+++ b/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
index 06cfc3c6..06cfc3c6 100644
--- a/docs/design/port-data-plane-status.rst
+++ b/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
index 2f6ce145..2f6ce145 100644
--- 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
diff --git a/docs/design/rfe-port-status-update.rst b/docs/development/design/rfe-port-status-update.rst
index d87d7d7b..d87d7d7b 100644
--- a/docs/design/rfe-port-status-update.rst
+++ b/docs/development/design/rfe-port-status-update.rst
diff --git a/docs/index.rst b/docs/development/index.rst
index a8349970..71974fe6 100755..100644
--- 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
index 824ea3c2..824ea3c2 100644
--- a/docs/manuals/get-valid-server-state.rst
+++ b/docs/development/manuals/get-valid-server-state.rst
diff --git a/docs/manuals/index.rst b/docs/development/manuals/index.rst
index 05831b2b..05831b2b 100644
--- a/docs/manuals/index.rst
+++ b/docs/development/manuals/index.rst
diff --git a/docs/manuals/mark-host-down_manual.rst b/docs/development/manuals/mark-host-down_manual.rst
index 3815205d..3815205d 100644
--- a/docs/manuals/mark-host-down_manual.rst
+++ b/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
index b3d73d5c..b3d73d5c 100644
--- a/docs/scenarios/functest/doctor-scenario-in-functest.rst
+++ b/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
index f2b47d20..21a2d03d 100644
--- 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
index e963d8bd..e963d8bd 100755
--- a/docs/scenarios/functest/images/figure-p1.png
+++ b/docs/development/overview/functest_scenario/images/figure-p1.png
Binary files differ
diff --git a/docs/requirements/01-intro.rst b/docs/development/requirements/01-intro.rst
index ed666cd1..ed666cd1 100644
--- a/docs/requirements/01-intro.rst
+++ b/docs/development/requirements/01-intro.rst
diff --git a/docs/requirements/02-use_cases.rst b/docs/development/requirements/02-use_cases.rst
index 0a1f6413..0a1f6413 100644
--- a/docs/requirements/02-use_cases.rst
+++ b/docs/development/requirements/02-use_cases.rst
diff --git a/docs/requirements/03-architecture.rst b/docs/development/requirements/03-architecture.rst
index b7417691..b7417691 100644
--- a/docs/requirements/03-architecture.rst
+++ b/docs/development/requirements/03-architecture.rst
diff --git a/docs/requirements/04-gaps.rst b/docs/development/requirements/04-gaps.rst
index b8ff7f2e..b8ff7f2e 100644
--- a/docs/requirements/04-gaps.rst
+++ b/docs/development/requirements/04-gaps.rst
diff --git a/docs/requirements/05-implementation.rst b/docs/development/requirements/05-implementation.rst
index 84979772..84979772 100644
--- a/docs/requirements/05-implementation.rst
+++ b/docs/development/requirements/05-implementation.rst
diff --git a/docs/requirements/06-summary.rst b/docs/development/requirements/06-summary.rst
index 61bf3f47..61bf3f47 100644
--- a/docs/requirements/06-summary.rst
+++ b/docs/development/requirements/06-summary.rst
diff --git a/docs/requirements/07-annex.rst b/docs/development/requirements/07-annex.rst
index c3a7899d..c3a7899d 100644
--- a/docs/requirements/07-annex.rst
+++ b/docs/development/requirements/07-annex.rst
diff --git a/docs/requirements/99-references.rst b/docs/development/requirements/99-references.rst
index 0fd3a36a..0fd3a36a 100644
--- a/docs/requirements/99-references.rst
+++ b/docs/development/requirements/99-references.rst
diff --git a/docs/requirements/glossary.rst b/docs/development/requirements/glossary.rst
index 2c82b37f..2c82b37f 100644
--- a/docs/requirements/glossary.rst
+++ b/docs/development/requirements/glossary.rst
diff --git a/docs/requirements/images/LICENSE b/docs/development/requirements/images/LICENSE
index f2b47d20..21a2d03d 100644
--- 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
index 267ddddc..267ddddc 100644
--- a/docs/requirements/images/figure1.png
+++ b/docs/development/requirements/images/figure1.png
Binary files differ
diff --git a/docs/requirements/images/figure10.png b/docs/development/requirements/images/figure10.png
index d3268018..d3268018 100755
--- a/docs/requirements/images/figure10.png
+++ b/docs/development/requirements/images/figure10.png
Binary files differ
diff --git a/docs/requirements/images/figure11.png b/docs/development/requirements/images/figure11.png
index b5fe0f8c..b5fe0f8c 100755
--- a/docs/requirements/images/figure11.png
+++ b/docs/development/requirements/images/figure11.png
Binary files differ
diff --git a/docs/requirements/images/figure12.png b/docs/development/requirements/images/figure12.png
index 2d394629..2d394629 100755
--- a/docs/requirements/images/figure12.png
+++ b/docs/development/requirements/images/figure12.png
Binary files differ
diff --git a/docs/requirements/images/figure13.png b/docs/development/requirements/images/figure13.png
index 5f8227a5..5f8227a5 100755
--- a/docs/requirements/images/figure13.png
+++ b/docs/development/requirements/images/figure13.png
Binary files differ
diff --git a/docs/requirements/images/figure14.png b/docs/development/requirements/images/figure14.png
index b65ca9ae..b65ca9ae 100755
--- a/docs/requirements/images/figure14.png
+++ b/docs/development/requirements/images/figure14.png
Binary files differ
diff --git a/docs/requirements/images/figure2.png b/docs/development/requirements/images/figure2.png
index 9a3b166d..9a3b166d 100644
--- a/docs/requirements/images/figure2.png
+++ b/docs/development/requirements/images/figure2.png
Binary files differ
diff --git a/docs/requirements/images/figure3.png b/docs/development/requirements/images/figure3.png
index ee04dfae..ee04dfae 100755
--- a/docs/requirements/images/figure3.png
+++ b/docs/development/requirements/images/figure3.png
Binary files differ
diff --git a/docs/requirements/images/figure4.png b/docs/development/requirements/images/figure4.png
index 9eff177a..9eff177a 100755
--- a/docs/requirements/images/figure4.png
+++ b/docs/development/requirements/images/figure4.png
Binary files differ
diff --git a/docs/requirements/images/figure5a.png b/docs/development/requirements/images/figure5a.png
index d347b412..d347b412 100755
--- a/docs/requirements/images/figure5a.png
+++ b/docs/development/requirements/images/figure5a.png
Binary files differ
diff --git a/docs/requirements/images/figure5b.png b/docs/development/requirements/images/figure5b.png
index 75a43669..75a43669 100755
--- a/docs/requirements/images/figure5b.png
+++ b/docs/development/requirements/images/figure5b.png
Binary files differ
diff --git a/docs/requirements/images/figure5c.png b/docs/development/requirements/images/figure5c.png
index 4fb2ba03..4fb2ba03 100755
--- a/docs/requirements/images/figure5c.png
+++ b/docs/development/requirements/images/figure5c.png
Binary files differ
diff --git a/docs/requirements/images/figure6.png b/docs/development/requirements/images/figure6.png
index cf0d2be9..cf0d2be9 100755
--- a/docs/requirements/images/figure6.png
+++ b/docs/development/requirements/images/figure6.png
Binary files differ
diff --git a/docs/requirements/images/figure7.png b/docs/development/requirements/images/figure7.png
index b88a2e65..b88a2e65 100755
--- a/docs/requirements/images/figure7.png
+++ b/docs/development/requirements/images/figure7.png
Binary files differ
diff --git a/docs/requirements/images/figure8.png b/docs/development/requirements/images/figure8.png
index 907a0b30..907a0b30 100755
--- a/docs/requirements/images/figure8.png
+++ b/docs/development/requirements/images/figure8.png
Binary files differ
diff --git a/docs/requirements/images/figure9.png b/docs/development/requirements/images/figure9.png
index 61501c4d..61501c4d 100755
--- a/docs/requirements/images/figure9.png
+++ b/docs/development/requirements/images/figure9.png
Binary files differ
diff --git a/docs/requirements/index.rst b/docs/development/requirements/index.rst
index fcbfb88e..fcbfb88e 100644
--- a/docs/requirements/index.rst
+++ b/docs/development/requirements/index.rst
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst
index 3ddc409c..3ddc409c 100644
--- a/docs/installationprocedure/feature.configuration.rst
+++ b/docs/release/configguide/feature.configuration.rst
diff --git a/docs/installationprocedure/index.rst b/docs/release/configguide/index.rst
index b74b91f8..ad89030b 100644
--- 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
index 00000000..6b0b43c5
--- /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
index 3732e027..eff14e58 100644
--- 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
index efb7b08c..efb7b08c 100644
--- a/docs/releasenotes/releasenotes.rst
+++ b/docs/release/installation/releasenotes.rst
diff --git a/docs/releasenotes/releasenotes_colorado.rst b/docs/release/installation/releasenotes_colorado.rst
index 505fbdb5..505fbdb5 100644
--- a/docs/releasenotes/releasenotes_colorado.rst
+++ b/docs/release/installation/releasenotes_colorado.rst
diff --git a/docs/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index 4ae521bd..4ae521bd 100644
--- a/docs/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
diff --git a/docs/userguide/index.rst b/docs/release/userguide/index.rst
index c6830fd1..c6830fd1 100644
--- a/docs/userguide/index.rst
+++ b/docs/release/userguide/index.rst
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
deleted file mode 100644
index 6fa37f6a..00000000
--- 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