diff options
30 files changed, 5 insertions, 502 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/release/templates/installation/<scenario>/<scenario>-installation.rst b/docs/release/templates/installation/<scenario>/<scenario>-installation.rst deleted file mode 100644 index a8cef90ba..000000000 --- a/docs/release/templates/installation/<scenario>/<scenario>-installation.rst +++ /dev/null @@ -1,22 +0,0 @@ -============================================= -<Project Name> <Release Name> Installation -============================================= - - -Preparing for Installation -===================================== -Include any pre configuration, database, or other software downloads -required to install <project>. - -Installing <Feature> -==================================== -Installation toolkit - -Verifying your Installation -==================================== -Describe how to verify the installation. - -Troubleshooting -==================================== -<optional> -Text goes here.
\ No newline at end of file diff --git a/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst b/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst deleted file mode 100644 index f60537566..000000000 --- a/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst +++ /dev/null @@ -1,17 +0,0 @@ -================================================= -<Project Name> <Release Name> Post Installation -================================================= - - -Post Installation Configuration -===================================== -Post Installation Configuration section must include some basic -(must-do) procedures if any, to get started. - -Upgrading From <a Previous Release> -==================================== -Text goes here. - -?Uninstalling? <Feature> -==================================== -Text here. diff --git a/docs/release/templates/installation/<scenario>/index.rst b/docs/release/templates/installation/<scenario>/index.rst deleted file mode 100644 index 053e341d5..000000000 --- a/docs/release/templates/installation/<scenario>/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -=================================== -<Scenario> Installation Guide -=================================== - -.. toctree:: - :maxdepth: 2 - - prerequisite - <scenario>-installation - <scenario>-postinstallation
\ No newline at end of file diff --git a/docs/release/templates/installation/abstract.rst b/docs/release/templates/installation/abstract.rst deleted file mode 100644 index 4868b1a2a..000000000 --- a/docs/release/templates/installation/abstract.rst +++ /dev/null @@ -1,6 +0,0 @@ -============================================= -<Project Name> <Release Name> Abstract -============================================= -.. Example, Joid Danube Abstract - -Abstract explaining the Document
\ No newline at end of file diff --git a/docs/release/templates/installation/compatibility.rst b/docs/release/templates/installation/compatibility.rst deleted file mode 100644 index ffed03042..000000000 --- a/docs/release/templates/installation/compatibility.rst +++ /dev/null @@ -1,18 +0,0 @@ -============================================== -<Project Name> <Release Name> Compatibility -============================================== - - -Compatibility with Previous Releases -======================================= -<optional, required if there's a previous release> -Is it compatible? Did anything about how a user or developer would -consume it change? If so, document it here. - -Migration from Previous Releases -===================================== -<optional, required if there's a previous release for the project> - -Describe any special step somebody would have to take to migrate from a -previous release to this one. If migration isn't supported for some -combinations, state that as well.
\ No newline at end of file diff --git a/docs/release/templates/installation/index.rst b/docs/release/templates/installation/index.rst deleted file mode 100644 index 032f8d40e..000000000 --- a/docs/release/templates/installation/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -=================================== -<Project Name> Installation Guide -=================================== - -Installation Guide -=================== -Refer to https://wiki.opnfv.org/display/DOC/Installation+procedure -Naming Convention is: <Name> <Use Case> <file name>. Eg: Apex Installation Guide Abstract - -.. toctree:: - :maxdepth: 2 - - abstract - prerequisite - supportedscenario - <scenario>/index - compatibility - references
\ No newline at end of file diff --git a/docs/release/templates/installation/prerequisite.rst b/docs/release/templates/installation/prerequisite.rst deleted file mode 100644 index 4f8a0069f..000000000 --- a/docs/release/templates/installation/prerequisite.rst +++ /dev/null @@ -1,15 +0,0 @@ -============================================= -<Project Name> <Release Name> Prerequisite -============================================= - - -Hardware requirement -===================================== -List out the HW requirements - -Software requirement -==================================== -List out the SW requirements - -Configurations -====================================
\ No newline at end of file diff --git a/docs/release/templates/installation/supportedscenario.rst b/docs/release/templates/installation/supportedscenario.rst deleted file mode 100644 index 3d78911f1..000000000 --- a/docs/release/templates/installation/supportedscenario.rst +++ /dev/null @@ -1,13 +0,0 @@ -=================================================== -<Project Name> <Release Name> Supported Scenarios -=================================================== - -<Brief> -========= -Add a short brief about supported scenarios - -.. toctree:: - :maxdepth: 2 - - development/<scenario1>/index - development/<scenario2>/index
\ No newline at end of file diff --git a/docs/release/templates/overview/index.rst b/docs/release/templates/overview/index.rst deleted file mode 100644 index 18e1dbd9d..000000000 --- a/docs/release/templates/overview/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -<Project Name> <Release Name> Overview -============================================= - -For example, the title might be "Qtip Danube Overview" - -<Brief (Optional)> -=================== - -.. toctree:: - :maxdepth: 2 - - overview diff --git a/docs/release/templates/overview/overview.rst b/docs/release/templates/overview/overview.rst deleted file mode 100644 index 163cdd3e0..000000000 --- a/docs/release/templates/overview/overview.rst +++ /dev/null @@ -1,13 +0,0 @@ -============================================== -<Project Name> <Release Name> Overview -============================================== - - -Introduction -======================================= -Describing the components and behaviours in a manner that helps people understand the platform and how to work with it - -Upgrades from <Previous Release> -===================================== -<optional, required if there's a previous release for the project> -Describe the new features
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/bugs.rst b/docs/release/templates/releasenotes/bugs.rst deleted file mode 100644 index fbb25dc58..000000000 --- a/docs/release/templates/releasenotes/bugs.rst +++ /dev/null @@ -1,63 +0,0 @@ -============================================= -<Project Name> <Release Name> Bugs -============================================= - - -Resolved Bugs -=============== -List open and resolved bugs if any. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+ - -Deprecated and Removed Capabilities -===================================== -Provide information about the capabilities that are removed or -deprecated in this release. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+ - -Known Limitations -===================================== -Provide information about the capabilities that are removed or -deprecated in this release. - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+ - -Open Bugs -===================================== -List any remaining open bugs. Ideally provide a short description and a -link to the entry in JIRA - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: APEX-86 | Need ability to specify number of | -| | compute nodes | -+--------------------------------------+--------------------------------------+
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/compatibility.rst b/docs/release/templates/releasenotes/compatibility.rst deleted file mode 100644 index ffed03042..000000000 --- a/docs/release/templates/releasenotes/compatibility.rst +++ /dev/null @@ -1,18 +0,0 @@ -============================================== -<Project Name> <Release Name> Compatibility -============================================== - - -Compatibility with Previous Releases -======================================= -<optional, required if there's a previous release> -Is it compatible? Did anything about how a user or developer would -consume it change? If so, document it here. - -Migration from Previous Releases -===================================== -<optional, required if there's a previous release for the project> - -Describe any special step somebody would have to take to migrate from a -previous release to this one. If migration isn't supported for some -combinations, state that as well.
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/deliverables.rst b/docs/release/templates/releasenotes/deliverables.rst deleted file mode 100644 index 25812085a..000000000 --- a/docs/release/templates/releasenotes/deliverables.rst +++ /dev/null @@ -1,12 +0,0 @@ -============================================== -<Project Name> <Release Name> Deliverables -============================================== - - -Software Deliverables -======================================= -List out the software deliverables - -Documentation Deliverables -===================================== -Call out the documentation deliverables
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/index.rst b/docs/release/templates/releasenotes/index.rst deleted file mode 100644 index 9530d803d..000000000 --- a/docs/release/templates/releasenotes/index.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -<Project Name> <Release Name> Release Notes -============================================= - -Abstract -=================== -Preface to what this document is about - -License -======= -Include Licensing information here - -Version History -=============== - - -+-------------+-----------+-----------------+----------------------+ -| **Date** | **Ver.** | **Authors** | **Comment** | -| | | | | -+-------------+-----------+-----------------+----------------------+ -| YYYY-MM-DD | X.X.X | Name | Comments | -+-------------+-----------+-----------------+----------------------+ -| YYYY-MM-DD | X.X.X | Name | Comments |+-------------+-----------+-----------------+----------------------+ -| YYYY-MM-DD | X.X.X | Name | Comments | -+-------------+-----------+-----------------+----------------------+ - -Contents -=============== - -.. toctree:: - :maxdepth: 2 - - summary - version - compatibility - bugs - deliverables - scenario/index - references diff --git a/docs/release/templates/releasenotes/newfeatures.rst b/docs/release/templates/releasenotes/newfeatures.rst deleted file mode 100644 index eab36cdca..000000000 --- a/docs/release/templates/releasenotes/newfeatures.rst +++ /dev/null @@ -1,23 +0,0 @@ -============================================= -<Project Name> <Release Name> New Features -============================================= - - -Major Capabilities and Enhancements -===================================== -Provide information about the major capabilities this project provides -in this release. Include those from previous release unless they have -been deprecated or removed (see below). - -New Capabilities and Enhancements -==================================== -Call out the new capabilities and/or enhancements that are present in -this release, but were not present in prior releases. - - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: <XXXXXX> | Brief here | -+--------------------------------------+--------------------------------------+ diff --git a/docs/release/templates/releasenotes/references.rst b/docs/release/templates/releasenotes/references.rst deleted file mode 100644 index 590aeb587..000000000 --- a/docs/release/templates/releasenotes/references.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================================== -<Project Name> <Release Name> References -============================================== - -List references
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/scenario/<scenarioname>.rst b/docs/release/templates/releasenotes/scenario/<scenarioname>.rst deleted file mode 100644 index 47c85ec15..000000000 --- a/docs/release/templates/releasenotes/scenario/<scenarioname>.rst +++ /dev/null @@ -1,37 +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> <Release Name> Release Notes -============================================= - - -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 Colorado release, please visit -http://www.opnfv.org/colorado
\ No newline at end of file diff --git a/docs/release/templates/releasenotes/scenario/index.rst b/docs/release/templates/releasenotes/scenario/index.rst deleted file mode 100644 index 7a2cf9bb1..000000000 --- a/docs/release/templates/releasenotes/scenario/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -<Release Name> Scenario Release Notes -============================================= - -<Brief (Optional)> -=================== - -.. toctree:: - :maxdepth: 2 - - <scenarioname> diff --git a/docs/release/templates/releasenotes/version.rst b/docs/release/templates/releasenotes/version.rst deleted file mode 100644 index ba552595a..000000000 --- a/docs/release/templates/releasenotes/version.rst +++ /dev/null @@ -1,13 +0,0 @@ -============================================== -<Project Name> <Release Name> Version -============================================== - - -Module version changes -======================== -List module level version changes - - -Document Version Changes -========================== -Changes in documentation
\ No newline at end of file diff --git a/docs/release/templates/scenario/index.rst b/docs/release/templates/scenario/index.rst deleted file mode 100644 index 44605fe7a..000000000 --- a/docs/release/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/release/templates/scenario/scenario.description.rst b/docs/release/templates/scenario/scenario.description.rst deleted file mode 100644 index 36098fd2f..000000000 --- a/docs/release/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 diff --git a/docs/release/templates/userguide/feature.userguide.rst b/docs/release/templates/userguide/feature.userguide.rst deleted file mode 100644 index 517f93d2f..000000000 --- a/docs/release/templates/userguide/feature.userguide.rst +++ /dev/null @@ -1,18 +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/release/templates/userguide/index.rst b/docs/release/templates/userguide/index.rst deleted file mode 100644 index 820155fdf..000000000 --- a/docs/release/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: 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 - diff --git a/docs/templates/release/configguide/postinstall.rst b/docs/templates/release/configguide/postinstall.rst index 51981a124..daca1ff51 100644 --- a/docs/templates/release/configguide/postinstall.rst +++ b/docs/templates/release/configguide/postinstall.rst @@ -13,7 +13,7 @@ according to this specific installer or feature. :local: Automated post installation activities --------------------------------------- +---------------------------------------- Describe specific post installation activities performed by the OPNFV deployment pipeline including testing activities and reports. Refer to the relevant testing guides, results, and release notes. @@ -24,7 +24,7 @@ case yet so each deploy tool will need to provide (hopefully very simillar) documentation of this. <Project> post configuration procedures --------------------------------------- +----------------------------------------- Describe any deploy tool or feature specific scripts, tests or procedures that should be carried out on the deployment post install and configuration in this section. diff --git a/docs/templates/release/design/index.rst b/docs/templates/release/design/index.rst new file mode 100644 index 000000000..9793092e5 --- /dev/null +++ b/docs/templates/release/design/index.rst @@ -0,0 +1 @@ +.. To be decided
\ No newline at end of file diff --git a/docs/templates/release/requirements/index.rst b/docs/templates/release/requirements/index.rst new file mode 100644 index 000000000..9793092e5 --- /dev/null +++ b/docs/templates/release/requirements/index.rst @@ -0,0 +1 @@ +.. To be decided
\ No newline at end of file diff --git a/docs/templates/testing/index.rst b/docs/templates/testing/index.rst new file mode 100644 index 000000000..9793092e5 --- /dev/null +++ b/docs/templates/testing/index.rst @@ -0,0 +1 @@ +.. To be decided
\ No newline at end of file |