diff options
| author |   ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-10 18:20:30 +0530 |
|---|---|---|
| committer |   Christopher Price <christopher.price@ericsson.com> | 2017-01-15 16:26:41 +0000 |
| commit | 326c546133c46a8fa51aee3631cc23d71cacaca4 (patch) | |
| tree | 6c62e8e41239e8922b7891d2b3ea879e118050a3 /docs/release/Templates/userguide | |
| parent | 26e52332eb28812b3415aaefc6f53a7637a222fe (diff) | |
Add new templates for docs contribution
Adding new templates for docs contribution to be used by the project
teams. Templates for 'Testing/' havent been added yet since its not
perfectly clear what all cases need to be documented.
Change-Id: Id9c1d0d87d99bb071cbcd493817500666cd59b79
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.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, 41 insertions, 0 deletions
diff --git a/docs/release/Templates/userguide/feature.userguide.rst b/docs/release/Templates/userguide/feature.userguide.rst new file mode 100644 index 000000000..517f93d2f --- /dev/null +++ b/docs/release/Templates/userguide/feature.userguide.rst @@ -0,0 +1,18 @@ +.. 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 new file mode 100644 index 000000000..820155fdf --- /dev/null +++ b/docs/release/Templates/userguide/index.rst @@ -0,0 +1,23 @@ +.. 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 + |