diff options
Diffstat (limited to 'docs/feature.templates/userguide')
| -rw-r--r-- | docs/feature.templates/userguide/feature.userguide.rst | 19 | ||||
| -rw-r--r-- | docs/feature.templates/userguide/index.rst | 23 |
2 files changed, 0 insertions, 42 deletions
diff --git a/docs/feature.templates/userguide/feature.userguide.rst b/docs/feature.templates/userguide/feature.userguide.rst deleted file mode 100644 index b8adfa592..000000000 --- a/docs/feature.templates/userguide/feature.userguide.rst +++ /dev/null @@ -1,19 +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/feature.templates/userguide/index.rst b/docs/feature.templates/userguide/index.rst deleted file mode 100644 index cc84670fc..000000000 --- a/docs/feature.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: 3 - -.. 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 - |