docs/sli/adaptors/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Release Notes
   4 =============
   5
   6 .. note::
   7    * This Release Notes must be updated each time the team decides to Release new artifacts.
   8    * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
   9    * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
  10    * 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.
  11    * This note must be removed after content has been added.
  12
  13
  14 Version: x.y.z
  15 --------------
  16
  17
  18 :Release Date: yyyy-mm-dd
  19
  20
  21
  22 **New Features**
  23
  24 One or two sentences explaining the purpose of this Release.
  25
  26 **Bug Fixes**
  27    - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
  28 **Known Issues**
  29    - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
  30      One sentences explaining what is the issue.
  31
  32      Another sentence explaining the impact of the issue.
  33
  34      And an optional sentence providing a workaround.
  35
  36 **Security Issues**
  37    You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
  38
  39
  40 **Upgrade Notes**
  41
  42 **Deprecation Notes**
  43
  44 **Other**
  45
  46 ===========