diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2016-08-31 16:58:13 +0200 |
|---|---|---|
| committer |   Brady Johnson <brady.allen.johnson@ericsson.com> | 2016-09-01 08:40:15 +0000 |
| commit | a0e2c1d0cbba861aac0b44bd61beb41ddca70630 (patch) | |
| tree | df2e9ae7e28afc2d90057c85af1ac49c24bf8d5f /docs/userguide | |
| parent | ecf444bb19bbfc538dffbadbe2d4701a8f67ff35 (diff) | |
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 <sofia.wallin@ericsson.com>
(cherry picked from commit d0bc418d7e4de5e1c2e4143570fa06fc60e1ac85)
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/feature.userguide.rst | 19 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 13 |
2 files changed, 32 insertions, 0 deletions
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) <optionally add copywriters name> + +<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. + 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) <optionally add copywriters name> + +************** +SFC User Guide +************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.userguide.rst |