Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 71817e0446f5186a1ca905be7b2cf40d13efe44e / . / docs / templates / sections / release-notes.rst
blob: 238b70bafd233e7f244787793518f195328920b3 [file] [log] [blame]
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Rich Bennett63f15922017-10-27 07:05:35 -0400[diff] [blame]2.. http://creativecommons.org/licenses/by/4.0
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]3.. (c) ONAP Project and its contributors
4
5***********************
6<project> Release Notes
7***********************
8
9Abstract
10========
11
12This document provides the release notes for the ``<releasename>`` release.
13
14Summary
15=======
16
17<Give a high level description of your project with regards to this specific release>
Rich Bennett63f15922017-10-27 07:05:35 -0400[diff] [blame]18
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]19
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]20Release Data
21============
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]22
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]23+--------------------------------------+--------------------------------------+
24| **Project** | |
25| | |
26+--------------------------------------+--------------------------------------+
27| **Docker images** | make sure you include all docker |
28| | images including the |
29| | release version |
30| | |
31+--------------------------------------+--------------------------------------+
32| **Release designation** | |
33| | |
34+--------------------------------------+--------------------------------------+
35| **Release date** | |
36| | |
37+--------------------------------------+--------------------------------------+
38
39New features
40------------
41
42<Describe new features or other new additions>
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]43
44
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]45Deliverables
46------------
47
48Software Deliverables
49~~~~~~~~~~~~~~~~~~~~~
50
51
52Documentation Deliverables
53~~~~~~~~~~~~~~~~~~~~~~~~~~
54
55
56Known Limitations, Issues and Workarounds
57=========================================
58
59System Limitations
60------------------
61
62
63Known Vulnerabilities
64---------------------
65
66
67Workarounds
68-----------
69
70
71Security Notes
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]72--------------
73
74
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]75Test Results
76============
77List or refer to any project specific results
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]78
79
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]80References
81==========
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]82
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]83For more information on the ONAP ``<release name>`` release, please see:
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]84
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]85#. `ONAP Home Page`_
86#. `ONAP Documentation`_
87#. `ONAP Release Downloads`_
88#. `ONAP Wiki Page`_
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]89
Rich Bennett7134cba2017-10-10 07:39:06 -0400[diff] [blame]90
Sofia Wallin7a91adf2019-12-18 11:37:55 +0100[diff] [blame]91.. _`ONAP Home Page`: https://www.onap.org
92.. _`ONAP Wiki Page`: https://wiki.onap.org
93.. _`ONAP Documentation`: https://docs.onap.org
94.. _`ONAP Release Downloads`: https://git.onap.org