diff options
author | Lusheng Ji <lji@research.att.com> | 2017-10-10 18:12:22 +0000 |
---|---|---|
committer | Lusheng Ji <lji@research.att.com> | 2017-10-10 18:12:34 +0000 |
commit | 72c4fbaceb680b3b34e177ccca11efe18de599f5 (patch) | |
tree | fefdb90f97f0e8d43772d77ea48f6f98a7c4945b /docs/sections/release-notes.rst | |
parent | c8d7ad73740989d2aa5d5cab41dcc7e0c960f0fa (diff) |
Draft docs
Issue-Id: DCAEGEN2-109
Change-Id: I85513ed5b34c0f60b8b0924b2016bbb3224beb9c
Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/release-notes.rst')
-rw-r--r-- | docs/sections/release-notes.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst new file mode 100644 index 00000000..ca257314 --- /dev/null +++ b/docs/sections/release-notes.rst @@ -0,0 +1,46 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +.. note:: + * This Release Notes must be updated each time the team decides to Release new artifacts. + * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. + * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. + * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. + * This note must be removed after content has been added. + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + +One or two sentences explaining the purpose of this Release. + +**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, three sentences. + One sentences explaining what is the issue. + + Another sentence explaining the impact of the issue. + + And an optional sentence providing a workaround. + +**Security Issues** + You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +=========== |