diff options
author | 2017-01-16 16:12:13 +0100 | |
---|---|---|
committer | 2017-01-16 16:12:13 +0100 | |
commit | 7881a0541c8b40663bba4aa3a5efdf9f3421e58f (patch) | |
tree | a48944226bf71a4a93d386d348a1ac6ca42a643a /docs/development/Templates | |
parent | 2e90847bdc1ef9ce49eb4c3424690fbb3460818f (diff) |
Adjusted naming path
Adjusted the naming path for consistency throughout our repository and the
community.
Change-Id: Ia055c418584f338f6000835fc28a7e5e8b5c5818
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/development/Templates')
-rw-r--r-- | docs/development/Templates/Design/design.rst | 0 | ||||
-rw-r--r-- | docs/development/Templates/Design/index.rst | 17 | ||||
-rw-r--r-- | docs/development/Templates/Integration/index.rst | 15 | ||||
-rw-r--r-- | docs/development/Templates/Scenario/index.rst | 15 | ||||
-rw-r--r-- | docs/development/Templates/Scenario/scenario.description.rst | 31 |
5 files changed, 0 insertions, 78 deletions
diff --git a/docs/development/Templates/Design/design.rst b/docs/development/Templates/Design/design.rst deleted file mode 100644 index e69de29bb..000000000 --- a/docs/development/Templates/Design/design.rst +++ /dev/null diff --git a/docs/development/Templates/Design/index.rst b/docs/development/Templates/Design/index.rst deleted file mode 100644 index 817a19440..000000000 --- a/docs/development/Templates/Design/index.rst +++ /dev/null @@ -1,17 +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> Design -===================== - -.. describe which upstream components (e.g. OpenStack modules, ..) are working together to provide the functionality -.. describe some deployment architecture -.. fill the gap between the release notes and the detailed documentation provided by the participating projects or upstream communities - -.. toctree:: - :maxdepth: 2 - - ./design.rst - diff --git a/docs/development/Templates/Integration/index.rst b/docs/development/Templates/Integration/index.rst deleted file mode 100644 index 2e7dd06d3..000000000 --- a/docs/development/Templates/Integration/index.rst +++ /dev/null @@ -1,15 +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> Integration -====================== - -Introduction -============== -..Brief on what scenario's the project can be integrated to. - -Integration Steps for <> -=========================== -.. List steps to integrate <project> with <scenario> diff --git a/docs/development/Templates/Scenario/index.rst b/docs/development/Templates/Scenario/index.rst deleted file mode 100644 index 44605fe7a..000000000 --- a/docs/development/Templates/Scenario/index.rst +++ /dev/null @@ -1,15 +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> - -=================================== -<scenario> Overview and Description -=================================== -.. 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: 3 - - ./scenario.description.rst diff --git a/docs/development/Templates/Scenario/scenario.description.rst b/docs/development/Templates/Scenario/scenario.description.rst deleted file mode 100644 index 36098fd2f..000000000 --- a/docs/development/Templates/Scenario/scenario.description.rst +++ /dev/null @@ -1,31 +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> - -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 |