summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjoehuang <joehuang@huawei.com>2016-08-30 03:01:09 -0400
committerjoehuang <joehuang@huawei.com>2016-08-30 03:10:13 -0400
commit4809d2adf23b6acaf74b448109814287e7cd0b17 (patch)
tree1d92c80bed7df89538f145414117dab57f1c2b30
parent6e8831dace9b8a773b21c643b22481fddd37409e (diff)
Update docs structure according to document structure guide
According to the document structure, feature projects are expected to store their documentation as following, <repo>/docs/userguide/feature.usage.rst <repo>/docs/userguide/index.rst <repo>/docs/installationprocedure/feature.configuration.rst <repo>/docs/installationprocedure/index.rst And as per previous release, <repo>/docs/releasenotes/release.notes.rst <repo>/docs/releasenotes/index.rst In multisite repo that we have both an installation instruction and a config guide. Need to combine these and then store them in <repo>/docs/installationprocedure/feature.configuration.rst And add release notes. Change-Id: I9ba0663640063488e232b1342174b10266ac77fc Signed-off-by: joehuang <joehuang@huawei.com>
-rw-r--r--docs/configurationguide/configuration.options.render.rst27
-rw-r--r--docs/installationprocedure/index.rst5
-rw-r--r--docs/installationprocedure/multisite.configuration.rst (renamed from docs/configurationguide/multisite-configuration-guide.rst)0
-rw-r--r--docs/installationprocedure/multisite.kingbird.configuration.rst (renamed from docs/configurationguide/multisite.kingbird.configuration.description.rst)0
-rw-r--r--docs/installationprocedure/multisite.kingbird.installation.rst (renamed from docs/installationprocedure/multisite.kingbird.installation.instruction.rst)0
-rw-r--r--docs/releasenotes/index.rst (renamed from docs/configurationguide/index.rst)10
-rw-r--r--docs/releasenotes/multisite.release.notes.rst16
-rw-r--r--docs/userguide/index.rst4
-rw-r--r--docs/userguide/multisite.admin.usage.rst (renamed from docs/userguide/multisite-admin-user-guide.rst)0
-rw-r--r--docs/userguide/multisite.kingbird.usage.rst (renamed from docs/userguide/multisite.kingbird.user.guide.rst)0
10 files changed, 26 insertions, 36 deletions
diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst
deleted file mode 100644
index f1dc11a..0000000
--- a/docs/configurationguide/configuration.options.render.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-=====================
-Configuration Options
-=====================
-
-OPNFV provides a variety of virtual infrastructure deployments called scenarios designed to
-host Virtualised Network Functions(VNFs). Each scenario provide specific capabilities and/or
-components aimed to solve specific problems for the deployment of VNF's. A scenario may include
-components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will include
-different source components or configurations.
-
-OPNFV Scenarios
-===============
-
-Each OPNFV scenario provides unique features and capabilities, it is important to understand
-your target platform capabilities before installing and configuring your target scenario.
-This configuration guide outlines how to install and configure components in order to enable
-the features you require.
-
-.. include:: ../scenario/scenariomatrix.rst
-
-This document will describe how to install and configure your target OPNFV scenarios.
-Remember to check the associated validation procedures section following your installation for
-details of the use cases and tests that have been run.
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
index bc51b95..746f819 100644
--- a/docs/installationprocedure/index.rst
+++ b/docs/installationprocedure/index.rst
@@ -13,6 +13,7 @@ Colorado 1.0
:maxdepth: 2
abstract.rst
- multisite.kingbird.installation.instruction.rst
- scenario.release.notes.rst
+ multisite.kingbird.installation.rst
+ multisite.configuration.rst
+ multisite.kingbird.configuration.rst
diff --git a/docs/configurationguide/multisite-configuration-guide.rst b/docs/installationprocedure/multisite.configuration.rst
index c005e8d..c005e8d 100644
--- a/docs/configurationguide/multisite-configuration-guide.rst
+++ b/docs/installationprocedure/multisite.configuration.rst
diff --git a/docs/configurationguide/multisite.kingbird.configuration.description.rst b/docs/installationprocedure/multisite.kingbird.configuration.rst
index d003019..d003019 100644
--- a/docs/configurationguide/multisite.kingbird.configuration.description.rst
+++ b/docs/installationprocedure/multisite.kingbird.configuration.rst
diff --git a/docs/installationprocedure/multisite.kingbird.installation.instruction.rst b/docs/installationprocedure/multisite.kingbird.installation.rst
index c43ca5a..c43ca5a 100644
--- a/docs/installationprocedure/multisite.kingbird.installation.instruction.rst
+++ b/docs/installationprocedure/multisite.kingbird.installation.rst
diff --git a/docs/configurationguide/index.rst b/docs/releasenotes/index.rst
index 791d94d..df1e186 100644
--- a/docs/configurationguide/index.rst
+++ b/docs/releasenotes/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
-*****************************
-Multisite Configuration Guide
-*****************************
+**************************
+Multisite Release Notes
+**************************
.. toctree::
:numbered:
- :maxdepth: 2
+ :maxdepth: 4
- multisite.kingbird.configuration.description.rst
+ multisite.release.notes.rst
diff --git a/docs/releasenotes/multisite.release.notes.rst b/docs/releasenotes/multisite.release.notes.rst
new file mode 100644
index 0000000..296e18b
--- /dev/null
+++ b/docs/releasenotes/multisite.release.notes.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV
+
+
+Release Notes of Multisite project
+==================================
+
+Multisite is to identify the requirements and gaps for the VIM(OpenStack)
+to support multi-site NFV cloud.
+
+The documentation of requirements, installation, configuration and usage
+guide for multi-site and Kingbird are provided.
+
+It's the first release for Kingbird service, known bugs are registered at
+https://bugs.launchpad.net/kingbird.
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 1429b33..25de482 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -9,5 +9,5 @@ Multisite Admin User Guide
:numbered:
:maxdepth: 4
- multisite-admin-user-guide.rst
- multisite.kingbird.user.guide.rst
+ multisite.admin.usage.rst
+ multisite.kingbird.usage.rst
diff --git a/docs/userguide/multisite-admin-user-guide.rst b/docs/userguide/multisite.admin.usage.rst
index 41f23c0..41f23c0 100644
--- a/docs/userguide/multisite-admin-user-guide.rst
+++ b/docs/userguide/multisite.admin.usage.rst
diff --git a/docs/userguide/multisite.kingbird.user.guide.rst b/docs/userguide/multisite.kingbird.usage.rst
index 6ae3881..6ae3881 100644
--- a/docs/userguide/multisite.kingbird.user.guide.rst
+++ b/docs/userguide/multisite.kingbird.usage.rst