summaryrefslogtreecommitdiffstats
path: root/docs/release/templates/releasenotes
diff options
context:
space:
mode:
authorShubhamRathi <shubhamiiitbackup@gmail.com>2017-01-29 23:34:14 +0530
committerShubham Rathi <shubhamiiitbackup@gmail.com>2017-01-30 07:31:50 +0000
commit68ada74c88cb3eae5422ac23594f0492ab1ae759 (patch)
tree4cd5945d6efd5abfe7058484209b47ab61243709 /docs/release/templates/releasenotes
parent0f688a1c18055cea888f1a208303940271942356 (diff)
Cleanup old templates and add placeholders where required
Old templates have beem eliminated. Placeholder index file has been added for design/, release/ & testing/. Change-Id: I536929924de42c855b6e775a1f2391db4cd04fc1 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/release/templates/releasenotes')
-rw-r--r--docs/release/templates/releasenotes/bugs.rst63
-rw-r--r--docs/release/templates/releasenotes/compatibility.rst18
-rw-r--r--docs/release/templates/releasenotes/deliverables.rst12
-rw-r--r--docs/release/templates/releasenotes/index.rst44
-rw-r--r--docs/release/templates/releasenotes/newfeatures.rst23
-rw-r--r--docs/release/templates/releasenotes/references.rst5
-rw-r--r--docs/release/templates/releasenotes/scenario/<scenarioname>.rst37
-rw-r--r--docs/release/templates/releasenotes/scenario/index.rst16
-rw-r--r--docs/release/templates/releasenotes/version.rst13
9 files changed, 0 insertions, 231 deletions
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