diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2017-01-16 16:12:13 +0100 |
|---|---|---|
| committer | Sofia Wallin <sofia.wallin@ericsson.com> | 2017-01-16 16:12:13 +0100 |
| commit | 7881a0541c8b40663bba4aa3a5efdf9f3421e58f (patch) | |
| tree | a48944226bf71a4a93d386d348a1ac6ca42a643a /docs/release/Templates/userguide | |
| parent | 2e90847bdc1ef9ce49eb4c3424690fbb3460818f (diff) | |
Adjusted naming path
Adjusted the naming path for consistency throughout our repository and the
community.
Change-Id: Ia055c418584f338f6000835fc28a7e5e8b5c5818
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/release/Templates/userguide')
| -rw-r--r-- | docs/release/Templates/userguide/feature.userguide.rst | 18 | ||||
| -rw-r--r-- | docs/release/Templates/userguide/index.rst | 23 |
2 files changed, 0 insertions, 41 deletions
diff --git a/docs/release/Templates/userguide/feature.userguide.rst b/docs/release/Templates/userguide/feature.userguide.rst deleted file mode 100644 index 517f93d2f..000000000 --- a/docs/release/Templates/userguide/feature.userguide.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. 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/release/Templates/userguide/index.rst b/docs/release/Templates/userguide/index.rst deleted file mode 100644 index 820155fdf..000000000 --- a/docs/release/Templates/userguide/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. 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> 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: 2 - -.. 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. - - ./feature.userguide.rst - |