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/scenarios | |
| 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/scenarios')
| -rw-r--r-- | docs/release/scenarios/os-odl-gluon-noha/index.rst | 16 | ||||
| -rw-r--r-- | docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst | 42 |
2 files changed, 58 insertions, 0 deletions
diff --git a/docs/release/scenarios/os-odl-gluon-noha/index.rst b/docs/release/scenarios/os-odl-gluon-noha/index.rst new file mode 100644 index 0000000..ae99305 --- /dev/null +++ b/docs/release/scenarios/os-odl-gluon-noha/index.rst @@ -0,0 +1,16 @@ +.. 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> + +================= +os-odl-gluon-noha +================= +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 1 + + scenario.description + diff --git a/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst b/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst new file mode 100644 index 0000000..7b316bb --- /dev/null +++ b/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst @@ -0,0 +1,42 @@ +.. 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 os-odl-gluon-noha +======================= + +This document provides scenario level details for the Danube release of Gluon. + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ +.. In this section explain the purpose of the scenario and the types of capabilities provided + +Scenario components and composition +----------------------------------- +.. In this section describe the unique components that make up the scenario, +.. what each component provides and why it has been included in order +.. to communicate to the user the capabilities available in this scenario. + +Scenario usage overview +----------------------- +.. Provide a brief overview on how to use the scenario and the features available to the +.. user. This should be an "introduction" to the userguide document, and explicitly link to it, +.. where the specifics of the features are covered including examples and API's + +Limitations, Issues and Workarounds +----------------------------------- +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +---------- + +For more information on the OPNFV Danube release, please visit +http://www.opnfv.org/danube + |