From d897a8fae077e366a9a9e1fa53d160b0db6e356a Mon Sep 17 00:00:00 2001 From: Giuseppe Carella Date: Wed, 30 Aug 2017 14:11:58 +0200 Subject: Extended documentation structure Change-Id: I7b1c40cc7cc92bca300281204a1623c7aa8f2999 Signed-off-by: Giuseppe Carella --- docs/release/userguide/feature.userguide.rst | 23 +++++++++++++++++++++++ docs/release/userguide/index.rst | 23 +++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 docs/release/userguide/feature.userguide.rst create mode 100644 docs/release/userguide/index.rst (limited to 'docs/release/userguide') 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 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. + + -- cgit 1.2.3-korg