From a0e2c1d0cbba861aac0b44bd61beb41ddca70630 Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Wed, 31 Aug 2016 16:58:13 +0200 Subject: Updated docs structure according to directives Created a sub directory /installationprocedure and added a template for installation and configuration /feature.configuration.rst together with an index.rst Added a /feature.userguide.rst and index.rst under /userguide. Adjusted the releasenotes, renamed the index.rst to releasenotes.rst and added a separate index.rst. Change-Id: I95583558bee739ea1a62e3a4692e872b8025b1b8 Signed-off-by: Sofia Wallin (cherry picked from commit d0bc418d7e4de5e1c2e4143570fa06fc60e1ac85) --- docs/userguide/feature.userguide.rst | 19 +++++++++++++++++++ docs/userguide/index.rst | 13 +++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/userguide/feature.userguide.rst create mode 100644 docs/userguide/index.rst (limited to 'docs/userguide') diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst new file mode 100644 index 00000000..b8adfa59 --- /dev/null +++ b/docs/userguide/feature.userguide.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + 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. + + 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. + + +----------------------------------------------- +.. 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/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 00000000..9bfd2433 --- /dev/null +++ b/docs/userguide/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) + +************** +SFC User Guide +************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.userguide.rst -- cgit 1.2.3-korg