summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2022-08-02 13:28:17 +0200
committerthmsdt <thomas.kulik@telekom.de>2022-08-04 11:51:51 +0200
commit21d59414fca273aade30aa4209aca9bb35a5f78f (patch)
treebd1a7449fddb04204f3c759b2877b49f92fe6a17 /docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
parent830bc298c26764f3d98f3ca98adf7b3c1b3d0a3a (diff)
update and rearrange documentation related content
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst127
1 files changed, 0 insertions, 127 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
deleted file mode 100644
index 11f38fed9..000000000
--- a/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
+++ /dev/null
@@ -1,127 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0
- International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) ONAP Project and its contributors
-.. _release_notes:
-
-***********************
-<project> Release Notes
-***********************
-
-.. note::
- * The release note needs to be updated for each ONAP release
- * Except the section "Release data" all other sections are optional and should be
- applied where applicable
- * Only the current release is to be documented in this document
- * This note needs to be removed before publishing the final result
-
-Abstract
-========
-
-This document provides the release notes for the ``<releasename>`` release.
-
-Summary
-=======
-
-<Give a high level description of your project with regards to this
-specific release>
-
-
-Release Data
-============
-
-+--------------------------------------+--------------------------------------+
-| **Project** | <project name> |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Docker images** | make sure you include all docker |
-| | images including the |
-| | release version |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release designation** | <release name followed by version> |
-| | |
-+--------------------------------------+--------------------------------------+
-
-
-New features
-------------
-
-<Describe new features or other new additions>
-
-**Bug fixes**
-
-- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining
- what this defect is addressing.
-
-**Known Issues**
-
-- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences
- explaining what this issue is.
-
-Deliverables
-------------
-
-Software Deliverables
-~~~~~~~~~~~~~~~~~~~~~
-
-
-Documentation Deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-Known Limitations, Issues and Workarounds
-=========================================
-
-System Limitations
-------------------
-
-Any known system limitations.
-
-
-Known Vulnerabilities
----------------------
-
-Results of know vulnerabilities analysis in used modules.
-
-
-Workarounds
------------
-
-Any known workarounds.
-
-
-Security Notes
---------------
-
-**Fixed Security Issues**
-
-List of security issues fixed in this release including CVEs and OJSI
-tickets.
-
-**Known Security Issues**
-
-List of new security issues that are left unfixed in this release including
-CVEs and OJSI tickets.
-
-
-Test Results
-============
-List or refer to any project specific results
-
-
-References
-==========
-
-For more information on the ONAP ``<release name>`` release, please see:
-
-#. `ONAP Home Page`_
-#. `ONAP Documentation`_
-#. `ONAP Release Downloads`_
-#. `ONAP Wiki Page`_
-
-
-.. _`ONAP Home Page`: https://www.onap.org
-.. _`ONAP Wiki Page`: https://wiki.onap.org
-.. _`ONAP Documentation`: https://docs.onap.org
-.. _`ONAP Release Downloads`: https://git.onap.org