Update documentation structure.

This patch includes adjusting docs directory structure for kvmfornfv
project.

Change-Id: Ic2f992cd5e8f6808ca3ba088172eb6da342182ba
Signed-off-by: Gundarapu Kalyan Reddy <reddyx.gundarapu@intel.com>

diff --git a/docs/index.rst b/docs/index.rst
index 1ae9553..b597d04 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,13 +23,13 @@ KVM4NFV Installation Procedure
 ******************************
 
 .. toctree::
-   :caption: Installation Procedure
+   :caption: Installation
    :numbered:
    :maxdepth: 4
 
-   ./release/installationprocedure/abstract.rst
-   ./release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst
-   ./release/installationprocedure/kvm4nfv-cicd.release.notes.rst
+   ./release/installation/abstract.rst
+   ./release/installation/kvm4nfv-cicd.installation.instruction.rst
+   ./release/installation/kvm4nfv-cicd.release.notes.rst
 
 ********************
 KVM4NFV Design Guide
@@ -62,10 +62,10 @@ KVM4NFV Configuration Guide
    :numbered:
    :maxdepth: 4
 
-   ./release/configurationguide/abstract.rst
-   ./release/configurationguide/configuration.options.render.rst
-   ./release/configurationguide/scenariomatrix.rst
-   ./release/configurationguide/low-latency.feature.configuration.description.rst
+   ./release/configguide/abstract.rst
+   ./release/configguide/configuration.options.render.rst
+   ./release/configguide/scenariomatrix.rst
+   ./release/configguide/low-latency.feature.configuration.description.rst
 
 ******************************************
 KVM4NFV Scenarios Overview and Description
@@ -155,14 +155,3 @@ KVM4NFV Releasenotes
    :maxdepth: 3
 
    ./release/releasenotes/release-notes.rst
-
-****************
-KVM4NFV Glossary
-****************
-
-.. toctree::
-   :caption: Glossary
-   :numbered:
-   :maxdepth: 3
-
-   ./release/glossary/kvmfornfv_glossary.rst

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

diff --git a/docs/release/configurationguide/configuration.options.render.rst b/docs/release/configguide/configuration.options.render.rst
similarity index 100%
rename from docs/release/configurationguide/configuration.options.render.rst
rename to docs/release/configguide/configuration.options.render.rst

diff --git a/docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg b/docs/release/configguide/images/brahmaputrafeaturematrix.jpg
similarity index 100%
rename from docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg
rename to docs/release/configguide/images/brahmaputrafeaturematrix.jpg

diff --git a/docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg b/docs/release/configguide/images/brahmaputrascenariomatrix.jpg
similarity index 100%
rename from docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg
rename to docs/release/configguide/images/brahmaputrascenariomatrix.jpg

diff --git a/docs/release/configurationguide/images/idle-idle-test.png b/docs/release/configguide/images/idle-idle-test.png
similarity index 100%
rename from docs/release/configurationguide/images/idle-idle-test.png
rename to docs/release/configguide/images/idle-idle-test.png

diff --git a/docs/release/configurationguide/images/stress-idle-test.png b/docs/release/configguide/images/stress-idle-test.png
similarity index 100%
rename from docs/release/configurationguide/images/stress-idle-test.png
rename to docs/release/configguide/images/stress-idle-test.png

diff --git a/docs/release/configurationguide/images/weather-clear.jpg b/docs/release/configguide/images/weather-clear.jpg
similarity index 100%
rename from docs/release/configurationguide/images/weather-clear.jpg
rename to docs/release/configguide/images/weather-clear.jpg

diff --git a/docs/release/configurationguide/images/weather-dash.jpg b/docs/release/configguide/images/weather-dash.jpg
similarity index 100%
rename from docs/release/configurationguide/images/weather-dash.jpg
rename to docs/release/configguide/images/weather-dash.jpg

diff --git a/docs/release/configurationguide/images/weather-few-clouds.jpg b/docs/release/configguide/images/weather-few-clouds.jpg
similarity index 100%
rename from docs/release/configurationguide/images/weather-few-clouds.jpg
rename to docs/release/configguide/images/weather-few-clouds.jpg

diff --git a/docs/release/configurationguide/images/weather-overcast.jpg b/docs/release/configguide/images/weather-overcast.jpg
similarity index 100%
rename from docs/release/configurationguide/images/weather-overcast.jpg
rename to docs/release/configguide/images/weather-overcast.jpg

diff --git a/docs/release/configurationguide/index.rst b/docs/release/configguide/index.rst
similarity index 91%
rename from docs/release/configurationguide/index.rst
rename to docs/release/configguide/index.rst
index fa205f5..6aa2786 100644 (file)
--- a/docs/release/configurationguide/index.rst
+++ b/docs/release/configguide/index.rst
@@ -16,4 +16,4 @@ Danube 1.0
    ./abstract.rst
    ./configuration.options.render.rst
    ./low-latency.feature.configuration.description.rst
-   ./os-nosdn-kvm-ha.description.rst
+   ./scenariomatrix.rst

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

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

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

diff --git a/docs/release/installationprocedure/index.rst b/docs/release/installation/index.rst
similarity index 75%
rename from docs/release/installationprocedure/index.rst
rename to docs/release/installation/index.rst
index 9d75307..87afea1 100644 (file)
--- a/docs/release/installationprocedure/index.rst
+++ b/docs/release/installation/index.rst
@@ -12,5 +12,6 @@ KVM4NFV Installation instruction
    :numbered:
    :maxdepth: 2
 
-   abstract.rst
-   kvm4nfv-cicd.installation.instruction.rst
+   ./abstract.rst
+   ./kvm4nfv-cicd.installation.instruction.rst
+   ./kvm4nfv-cicd.release.notes.rst

diff --git a/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/release/installation/kvm4nfv-cicd.installation.instruction.rst
similarity index 100%
rename from docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst
rename to docs/release/installation/kvm4nfv-cicd.installation.instruction.rst

diff --git a/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst b/docs/release/installation/kvm4nfv-cicd.release.notes.rst
similarity index 100%
rename from docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst
rename to docs/release/installation/kvm4nfv-cicd.release.notes.rst

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

diff --git a/docs/release/releasenotes/release-notes.rst b/docs/release/release-notes/release-notes.rst
similarity index 98%
rename from docs/release/releasenotes/release-notes.rst
rename to docs/release/release-notes/release-notes.rst
index c52b4b8..e08341f 100644 (file)
--- a/docs/release/releasenotes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -77,8 +77,6 @@ CI pipeline, including:
 
   * Requirements Guide
 
-The *KVM4NFV framework* is developed in the OPNFV community, by the
-KVM4NFV_ team.
 
 Release Data
 ------------
@@ -205,7 +203,7 @@ Deliverables
 
   * os-nosdn-kvm_nfv_ovs_dpdk_bar-ha
 
-* Configured influxdb and `Graphana dashboard`_ for publishing kvm4nfv test results
+* Configured influxdb and `Graphana_dashboard`_ for publishing kvm4nfv test results
 
 .. _Graphana_dashboard: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest
 

diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
index ff68987..00fe6c8 100644 (file)
--- a/docs/release/userguide/index.rst
+++ b/docs/release/userguide/index.rst
@@ -23,3 +23,4 @@ KVM4NFV User Guide
    ./packet_forwarding.userguide.rst
    ./pcm_utility.userguide.rst
    ./tuning.userguide.rst
+   ./kvmfornfv_glossary.rst

diff --git a/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst b/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst
index 468f471..c119b43 100644 (file)
--- a/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst
+++ b/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst
@@ -202,7 +202,7 @@ Influxdb api which is already implemented in `Influxdb`_ will post the data in l
 ``Displaying Results on Grafana dashboard:``
 
 - Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to display the cyclictest results
-on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_
+on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_\
 
 - Grafana can be accessed at `Login`_ using credentials opnfv/opnfv and used for visualizing the collected test data as shown in `Visual`_\
 

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