summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-07-12 16:22:17 +0200
committerRyota Mibu <r-mibu@cq.jp.nec.com>2016-07-22 11:44:52 +0000
commit2b890ae86bc8dcc16cc7e1f0cb00357c7892486b (patch)
treeb8dd9c1c18f2e4f6cf6e7e38a460322397c8bf56
parent3ecf7ea5fe5611fea3550fb8065f5ffe0859f17d (diff)
Modified the templates for the C release
We are getting there.... Change-Id: I8cdf4b2a642a653b0eaa48acf8a7e46bf4a2f98d Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
-rw-r--r--docs/configurationguide/index.rst10
-rw-r--r--docs/configurationguide/scenario.description.rst18
-rw-r--r--docs/glossary/index.rst2
-rw-r--r--docs/installationprocedure/abstract.rst7
-rw-r--r--docs/installationprocedure/index.rst5
-rw-r--r--docs/installationprocedure/scenario.release.notes.rst16
-rw-r--r--docs/platformoverview/index.rst2
-rw-r--r--docs/userguide/index.rst15
8 files changed, 44 insertions, 31 deletions
diff --git a/docs/configurationguide/index.rst b/docs/configurationguide/index.rst
index 1b0fec4ce..9bf442a42 100644
--- a/docs/configurationguide/index.rst
+++ b/docs/configurationguide/index.rst
@@ -5,12 +5,14 @@
*************************
OPNFV Configuration Guide
*************************
+Colorado 1.0
+------------
.. toctree::
:maxdepth: 2
- ./abstract
- ./configuration.options.render
- ./feature.configuration.description
- ./installer.procedure.render
+ ./abstract.rst
+ ./configuration.options.render.rst
+ ./feature.configuration.description.rst
+ ./scenario.description.rst
diff --git a/docs/configurationguide/scenario.description.rst b/docs/configurationguide/scenario.description.rst
index c0925c507..c318e6f59 100644
--- a/docs/configurationguide/scenario.description.rst
+++ b/docs/configurationguide/scenario.description.rst
@@ -2,19 +2,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Sofia Wallin (Ericsson AB)
-=====================
-Installation of <xxx>
-=====================
+====================
+Scenario description
+====================
-Introduction
-------------
-Describe the capabilities and associated features of each installer.
-
-Pre-installation activities
----------------------------
-List the acitvites needed for pre-installation.
-
-Hardware requirement
---------------------
-List the HW requirement for each installer
+This document will describe and link to the scenario installation instructions.
diff --git a/docs/glossary/index.rst b/docs/glossary/index.rst
index be5b6d732..75aa5a026 100644
--- a/docs/glossary/index.rst
+++ b/docs/glossary/index.rst
@@ -5,6 +5,8 @@
**************
OPNFV Glossary
**************
+Colorado 1.0
+------------
========
Contents
diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst
index e69de29bb..b9b85b0c0 100644
--- a/docs/installationprocedure/abstract.rst
+++ b/docs/installationprocedure/abstract.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+This document will give the user instructions on how to deploy
+available scenarios verfied for the Colorado release of the OPNFV
+platform.
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
index 9503c7b50..e69204b98 100644
--- a/docs/installationprocedure/index.rst
+++ b/docs/installationprocedure/index.rst
@@ -5,11 +5,14 @@
**********************
Installation procedure
**********************
+Colorado 1.0
+------------
.. toctree::
:numbered:
:maxdepth: 2
abstract.rst
- scenario.installation.instruction
+ scenario.installation.instruction.rst
+ scenario.release.notes.rst
diff --git a/docs/installationprocedure/scenario.release.notes.rst b/docs/installationprocedure/scenario.release.notes.rst
index 545e1d9bf..eaffd9b19 100644
--- a/docs/installationprocedure/scenario.release.notes.rst
+++ b/docs/installationprocedure/scenario.release.notes.rst
@@ -2,9 +2,11 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-=================================================
-Release Note for the Brahmaputra release of OPNFV
-=================================================
+===========================
+Release Note for <scenario>
+===========================
+Colorado 1.0
+------------
.. toctree::
:maxdepth: 2
@@ -12,15 +14,15 @@ Release Note for the Brahmaputra release of OPNFV
Abstract
========
-This document compiles the release notes for the Brahmaputra release of
-OPNFV when using <XYZ> as a deployment tool.
+This document contains the release notes for the Colorado release of
+OPNFV when using <scenario>.
Introduction
============
-Provide a breif introduction of how this release is used in OPNFV relese using <XYZ> as a deployment tool
+Provide a breif introduction of how this configuration is used in OPNFV relese using <scenario> as scenario.
-Be sure to reference your installation-instructions.
+Be sure to reference your scenario installation instruction.
Release Data
============
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
index ca3bf449d..49252002c 100644
--- a/docs/platformoverview/index.rst
+++ b/docs/platformoverview/index.rst
@@ -5,6 +5,8 @@
********************************
OPNFV Platform Overview Document
********************************
+Colorado 1.0
+------------
.. toctree::
:maxdepth: 2
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index d7c6d7382..c5c369333 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -5,13 +5,18 @@
****************
OPNFV User Guide
****************
+Colorado 1.0
+------------
.. toctree::
:maxdepth: 2
- ./abstract
- ./introduction
- ./general-system
- ./feature-usage
- ./test-usage
+ ./abstract.rst
+ ./introduction.rst
+ ./common.platform.render.rst
+ ./onos.rst
+ ./opendaylight.rst
+ ./openstack.rst
+ ./feature.userguide.render.rst
+ ./feature.userguide.template.rst