summaryrefslogtreecommitdiffstats
path: root/docs/release
diff options
context:
space:
mode:
authorGiuseppe Carella <cargius@gmail.com>2017-08-30 14:11:58 +0200
committerGiuseppe Carella <cargius@gmail.com>2017-08-30 14:12:23 +0200
commitd897a8fae077e366a9a9e1fa53d160b0db6e356a (patch)
treea8c990c6f5481c5cca8dba811adfaf80abc74ca5 /docs/release
parent8b6af8882815382610515bd63337a0a5ac92d2cb (diff)
Extended documentation structure
Change-Id: I7b1c40cc7cc92bca300281204a1623c7aa8f2999 Signed-off-by: Giuseppe Carella <cargius@gmail.com>
Diffstat (limited to 'docs/release')
-rw-r--r--docs/release/configguide/feature.configuration.rst34
-rw-r--r--docs/release/configguide/index.rst11
-rw-r--r--docs/release/release-notes/orchestra-release.rst2
-rw-r--r--docs/release/userguide/feature.userguide.rst23
-rw-r--r--docs/release/userguide/index.rst23
5 files changed, 92 insertions, 1 deletions
diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst
new file mode 100644
index 0000000..32e20f9
--- /dev/null
+++ b/docs/release/configguide/feature.configuration.rst
@@ -0,0 +1,34 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+========
+Abstract
+========
+Add a brief introduction to configure OPNFV with this specific feature including
+dependancies on platform components, this description should be at a level that
+will apply to any installer providing the pre-requisite components.
+
+.. contents::
+ :depth: 3
+ :local:
+
+Pre-configuration activities
+============================
+Describe specific pre-configuration activities. This should include ensuring the
+right components are installed by the installation tools as required for your
+feature to function. Refer to the previous installer configuration chapters,
+installations guide and release notes
+
+
+Hardware configuration
+======================
+Describe the hardware configuration needed for this specific feature
+
+
+Orchestra configuration
+=====================
+Describe the procedures to configure your feature on the platform in order
+that it is ready to use according to the feature instructions in the platform
+user guide. Where applicable you should add content in the postinstall.rst
+to validate the feature is configured for use.
+(checking components are installed correctly etc...)
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 0000000..4039341
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**********************************
+Orchestra Configuration Guide
+**********************************
+
+.. toctree::
+ :maxdepth: 1
+
+ feature.configuration
diff --git a/docs/release/release-notes/orchestra-release.rst b/docs/release/release-notes/orchestra-release.rst
index 9c241bf..7e514d1 100644
--- a/docs/release/release-notes/orchestra-release.rst
+++ b/docs/release/release-notes/orchestra-release.rst
@@ -21,7 +21,7 @@ Version history
| | | | |
+------------+----------+--------------------+------------------------+
| 2017-08-25 | 1.0.0 | Giuseppe Carella | Functest for |
-| | | (Fraunhofer FOKUS) | Colorado.1.0 release |
+| | | (Fraunhofer FOKUS) | Euphrates.1.0 release |
+------------+----------+--------------------+------------------------+
OPNFV Orchestra Euphrates Release
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
new file mode 100644
index 0000000..28fd9bc
--- /dev/null
+++ b/docs/release/userguide/feature.userguide.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Fraunhofer FOKUS
+
+.. contents::
+ :depth: 3
+ :local:
+
+Orchestra description
+=====================
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+
+Orchestra capabilities and usage
+================================
+.. Describe the specific capabilities and usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+
+Feature and API usage guidelines and example
+============================================
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
+
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644
index 0000000..8e2df17
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Fraunhofer FOKUS
+
+=====================
+Orchestra User Guide
+=====================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+ :maxdepth: 1
+
+ feature.userguide
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+