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/ReleaseNotes | |
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/ReleaseNotes')
-rw-r--r-- | docs/release/Templates/ReleaseNotes/bugs.rst | 63 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/compatibility.rst | 18 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/deliverables.rst | 12 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/index.rst | 44 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/newfeatures.rst | 23 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/references.rst | 5 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/scenario/<scenarioname>.rst | 37 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/scenario/index.rst | 16 | ||||
-rw-r--r-- | docs/release/Templates/ReleaseNotes/version.rst | 13 |
9 files changed, 231 insertions, 0 deletions
diff --git a/docs/release/Templates/ReleaseNotes/bugs.rst b/docs/release/Templates/ReleaseNotes/bugs.rst new file mode 100644 index 000000000..fbb25dc58 --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/bugs.rst @@ -0,0 +1,63 @@ +============================================= +<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 new file mode 100644 index 000000000..ffed03042 --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/compatibility.rst @@ -0,0 +1,18 @@ +============================================== +<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 new file mode 100644 index 000000000..25812085a --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/deliverables.rst @@ -0,0 +1,12 @@ +============================================== +<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 new file mode 100644 index 000000000..9530d803d --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/index.rst @@ -0,0 +1,44 @@ +.. 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 new file mode 100644 index 000000000..eab36cdca --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/newfeatures.rst @@ -0,0 +1,23 @@ +============================================= +<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 new file mode 100644 index 000000000..590aeb587 --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/references.rst @@ -0,0 +1,5 @@ +============================================== +<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 new file mode 100644 index 000000000..47c85ec15 --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/scenario/<scenarioname>.rst @@ -0,0 +1,37 @@ +.. 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 new file mode 100644 index 000000000..7a2cf9bb1 --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/scenario/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) 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 new file mode 100644 index 000000000..ba552595a --- /dev/null +++ b/docs/release/Templates/ReleaseNotes/version.rst @@ -0,0 +1,13 @@ +============================================== +<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 |