diff options
| author |   Stuart Mackie <wsmackie@juniper.net> | 2017-09-14 23:26:31 -0700 |
|---|---|---|
| committer | Stuart Mackie <wsmackie@juniper.net> | 2017-09-14 23:26:31 -0700 |
| commit | fd876b7dbc7d517a706b22e52bf6f0e8f79a0b4b (patch) | |
| tree | 996858dd4abe0221f8f9d54a2aeeb4ffb9971b8e /docs/templates/release/userguide | |
| parent | fce102283bab73ed08c292fce03e39c52f4a1fe2 (diff) | |
Docs
Change-Id: Iea3001f8414267f1535353f28d30d45daf9a3e66
Signed-off-by: Stuart Mackie <wsmackie@juniper.net>
Diffstat (limited to 'docs/templates/release/userguide')
| -rw-r--r-- | docs/templates/release/userguide/feature.userguide.rst | 23 | ||||
| -rw-r--r-- | docs/templates/release/userguide/index.rst | 23 |
2 files changed, 0 insertions, 46 deletions
diff --git a/docs/templates/release/userguide/feature.userguide.rst b/docs/templates/release/userguide/feature.userguide.rst deleted file mode 100644 index 1d54d0e..0000000 --- a/docs/templates/release/userguide/feature.userguide.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> - -.. 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. - diff --git a/docs/templates/release/userguide/index.rst b/docs/templates/release/userguide/index.rst deleted file mode 100644 index 5fec000..0000000 --- a/docs/templates/release/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: 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. - - |