summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorkalyanreddy <reddyx.gundarapu@intel.com>2017-03-28 13:18:51 -0700
committerKalyan reddy Gundarapu <reddyx.gundarapu@intel.com>2017-03-28 20:31:47 +0000
commit8815494ebba1bbb37ab0a9f9700f5dfb33cf12fb (patch)
tree2279eb6b67b66ec16c4817d4e1bbe988e94eb535
parentb04935b08394a9b64b69429215e27f0323065bfa (diff)
Update documentation structure.danube.1.0
This patch includes adjusting docs directory structure for kvmfornfv project. Change-Id: Ic2f992cd5e8f6808ca3ba088172eb6da342182ba Signed-off-by: Gundarapu Kalyan Reddy <reddyx.gundarapu@intel.com>
-rw-r--r--docs/index.rst27
-rw-r--r--docs/release/configguide/abstract.rst (renamed from docs/release/configurationguide/abstract.rst)0
-rw-r--r--docs/release/configguide/configuration.options.render.rst (renamed from docs/release/configurationguide/configuration.options.render.rst)0
-rw-r--r--docs/release/configguide/images/brahmaputrafeaturematrix.jpg (renamed from docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg)bin62966 -> 62966 bytes
-rw-r--r--docs/release/configguide/images/brahmaputrascenariomatrix.jpg (renamed from docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg)bin51071 -> 51071 bytes
-rw-r--r--docs/release/configguide/images/idle-idle-test.png (renamed from docs/release/configurationguide/images/idle-idle-test.png)bin14901 -> 14901 bytes
-rw-r--r--docs/release/configguide/images/stress-idle-test.png (renamed from docs/release/configurationguide/images/stress-idle-test.png)bin19033 -> 19033 bytes
-rw-r--r--docs/release/configguide/images/weather-clear.jpg (renamed from docs/release/configurationguide/images/weather-clear.jpg)bin1286 -> 1286 bytes
-rw-r--r--docs/release/configguide/images/weather-dash.jpg (renamed from docs/release/configurationguide/images/weather-dash.jpg)bin1010 -> 1010 bytes
-rw-r--r--docs/release/configguide/images/weather-few-clouds.jpg (renamed from docs/release/configurationguide/images/weather-few-clouds.jpg)bin1348 -> 1348 bytes
-rw-r--r--docs/release/configguide/images/weather-overcast.jpg (renamed from docs/release/configurationguide/images/weather-overcast.jpg)bin1215 -> 1215 bytes
-rw-r--r--docs/release/configguide/index.rst (renamed from docs/release/configurationguide/index.rst)2
-rw-r--r--docs/release/configguide/low-latency.feature.configuration.description.rst (renamed from docs/release/configurationguide/low-latency.feature.configuration.description.rst)0
-rw-r--r--docs/release/configguide/scenariomatrix.rst (renamed from docs/release/configurationguide/scenariomatrix.rst)0
-rw-r--r--docs/release/installation/abstract.rst (renamed from docs/release/installationprocedure/abstract.rst)0
-rw-r--r--docs/release/installation/index.rst (renamed from docs/release/installationprocedure/index.rst)5
-rw-r--r--docs/release/installation/kvm4nfv-cicd.installation.instruction.rst (renamed from docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst)0
-rw-r--r--docs/release/installation/kvm4nfv-cicd.release.notes.rst (renamed from docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst)0
-rw-r--r--docs/release/release-notes/index.rst (renamed from docs/release/releasenotes/index.rst)0
-rw-r--r--docs/release/release-notes/release-notes.rst (renamed from docs/release/releasenotes/release-notes.rst)4
-rw-r--r--docs/release/userguide/index.rst1
-rw-r--r--docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst2
-rw-r--r--docs/release/userguide/kvmfornfv_glossary.rst (renamed from docs/release/glossary/kvmfornfv_glossary.rst)0
23 files changed, 15 insertions, 26 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 1ae9553..b597d04 100644
--- 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
index 3693bca..3693bca 100644
--- a/docs/release/configurationguide/abstract.rst
+++ b/docs/release/configguide/abstract.rst
diff --git a/docs/release/configurationguide/configuration.options.render.rst b/docs/release/configguide/configuration.options.render.rst
index 71a78af..71a78af 100644
--- a/docs/release/configurationguide/configuration.options.render.rst
+++ b/docs/release/configguide/configuration.options.render.rst
diff --git a/docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg b/docs/release/configguide/images/brahmaputrafeaturematrix.jpg
index 0d2a122..0d2a122 100644
--- a/docs/release/configurationguide/images/brahmaputrafeaturematrix.jpg
+++ b/docs/release/configguide/images/brahmaputrafeaturematrix.jpg
Binary files differ
diff --git a/docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg b/docs/release/configguide/images/brahmaputrascenariomatrix.jpg
index 84fc87a..84fc87a 100644
--- a/docs/release/configurationguide/images/brahmaputrascenariomatrix.jpg
+++ b/docs/release/configguide/images/brahmaputrascenariomatrix.jpg
Binary files differ
diff --git a/docs/release/configurationguide/images/idle-idle-test.png b/docs/release/configguide/images/idle-idle-test.png
index c9831df..c9831df 100644
--- a/docs/release/configurationguide/images/idle-idle-test.png
+++ b/docs/release/configguide/images/idle-idle-test.png
Binary files differ
diff --git a/docs/release/configurationguide/images/stress-idle-test.png b/docs/release/configguide/images/stress-idle-test.png
index 111c2a7..111c2a7 100644
--- a/docs/release/configurationguide/images/stress-idle-test.png
+++ b/docs/release/configguide/images/stress-idle-test.png
Binary files differ
diff --git a/docs/release/configurationguide/images/weather-clear.jpg b/docs/release/configguide/images/weather-clear.jpg
index 011ad52..011ad52 100644
--- a/docs/release/configurationguide/images/weather-clear.jpg
+++ b/docs/release/configguide/images/weather-clear.jpg
Binary files differ
diff --git a/docs/release/configurationguide/images/weather-dash.jpg b/docs/release/configguide/images/weather-dash.jpg
index 3bf98dd..3bf98dd 100644
--- a/docs/release/configurationguide/images/weather-dash.jpg
+++ b/docs/release/configguide/images/weather-dash.jpg
Binary files differ
diff --git a/docs/release/configurationguide/images/weather-few-clouds.jpg b/docs/release/configguide/images/weather-few-clouds.jpg
index 51994ee..51994ee 100644
--- a/docs/release/configurationguide/images/weather-few-clouds.jpg
+++ b/docs/release/configguide/images/weather-few-clouds.jpg
Binary files differ
diff --git a/docs/release/configurationguide/images/weather-overcast.jpg b/docs/release/configguide/images/weather-overcast.jpg
index bdc1e04..bdc1e04 100644
--- a/docs/release/configurationguide/images/weather-overcast.jpg
+++ b/docs/release/configguide/images/weather-overcast.jpg
Binary files differ
diff --git a/docs/release/configurationguide/index.rst b/docs/release/configguide/index.rst
index fa205f5..6aa2786 100644
--- 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
index c53aa52..c53aa52 100644
--- a/docs/release/configurationguide/low-latency.feature.configuration.description.rst
+++ b/docs/release/configguide/low-latency.feature.configuration.description.rst
diff --git a/docs/release/configurationguide/scenariomatrix.rst b/docs/release/configguide/scenariomatrix.rst
index 3da38ed..3da38ed 100644
--- a/docs/release/configurationguide/scenariomatrix.rst
+++ b/docs/release/configguide/scenariomatrix.rst
diff --git a/docs/release/installationprocedure/abstract.rst b/docs/release/installation/abstract.rst
index a53450e..a53450e 100644
--- a/docs/release/installationprocedure/abstract.rst
+++ b/docs/release/installation/abstract.rst
diff --git a/docs/release/installationprocedure/index.rst b/docs/release/installation/index.rst
index 9d75307..87afea1 100644
--- 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
index dedcca3..dedcca3 100644
--- a/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst
+++ b/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
index 415182b..415182b 100644
--- a/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst
+++ b/docs/release/installation/kvm4nfv-cicd.release.notes.rst
diff --git a/docs/release/releasenotes/index.rst b/docs/release/release-notes/index.rst
index 3cf19f3..3cf19f3 100644
--- a/docs/release/releasenotes/index.rst
+++ b/docs/release/release-notes/index.rst
diff --git a/docs/release/releasenotes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index c52b4b8..e08341f 100644
--- 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
--- 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
--- 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
index aed5a97..aed5a97 100644
--- a/docs/release/glossary/kvmfornfv_glossary.rst
+++ b/docs/release/userguide/kvmfornfv_glossary.rst