diff options
| author |   Georg Kunz <georg.kunz@ericsson.com> | 2017-02-15 11:01:42 +0100 |
|---|---|---|
| committer | Georg Kunz <georg.kunz@ericsson.com> | 2017-02-17 11:11:17 +0100 |
| commit | 7d501c4ea14ca3f6294798e010b68395b99aa70b (patch) | |
| tree | 0f7d69f78ea7319a9b4de1283cfc9ac0500f71d4 /docs/release/userguide | |
| parent | 69a8847f21a811b7e3e6a883f36378c2ce76278b (diff) | |
Adding template framework for Danube documentation
Change-Id: I0960f3538163e2609db9a196d665f148967ab454
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
Diffstat (limited to 'docs/release/userguide')
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 27 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 23 |
2 files changed, 50 insertions, 0 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..69236c6 --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,27 @@ +.. 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> + +========================= +OPNFV NetReady User Guide +========================= + +.. contents:: + :depth: 3 + :local: + +Gluon 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. + +Gluon 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. + +Gluon API guidelines and examples +--------------------------------- +.. 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/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..5fec000 --- /dev/null +++ b/docs/release/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: 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. + + |