summaryrefslogtreecommitdiffstats
path: root/docs/release/userguide
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/userguide
parent8b6af8882815382610515bd63337a0a5ac92d2cb (diff)
Extended documentation structure
Change-Id: I7b1c40cc7cc92bca300281204a1623c7aa8f2999 Signed-off-by: Giuseppe Carella <cargius@gmail.com>
Diffstat (limited to 'docs/release/userguide')
-rw-r--r--docs/release/userguide/feature.userguide.rst23
-rw-r--r--docs/release/userguide/index.rst23
2 files changed, 46 insertions, 0 deletions
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.
+
+