summaryrefslogtreecommitdiffstats
path: root/docs/templates/release/userguide/feature.userguide.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2017-02-15 13:25:03 +0100
committerAric Gardner <agardner@linuxfoundation.org>2017-02-20 19:07:51 +0000
commit5b6b3ed958264ecddc586624ba23bfc2d5c88a4c (patch)
treec7c931b741afe52a6ea8cd78dedd414c5961475a /docs/templates/release/userguide/feature.userguide.rst
parent557f19ce936999835754e0fa917f635a4bf54e1c (diff)
Adjusted titles
Updated according to comments and added the SFC feature configuration as template under release/configguide. Adjusted all titles so they are handled through the index file. Change-Id: Icb0339fb19394940dc969725ddfe0420cb547955 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/templates/release/userguide/feature.userguide.rst')
-rw-r--r--docs/templates/release/userguide/feature.userguide.rst10
1 files changed, 3 insertions, 7 deletions
diff --git a/docs/templates/release/userguide/feature.userguide.rst b/docs/templates/release/userguide/feature.userguide.rst
index 733c2f99a..1d54d0ec7 100644
--- a/docs/templates/release/userguide/feature.userguide.rst
+++ b/docs/templates/release/userguide/feature.userguide.rst
@@ -2,26 +2,22 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-===================================
-OPNFV <Project Name> User Guide
-===================================
-
.. contents::
:depth: 3
:local:
<Feature> 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.
<Feature> 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.