diff options
author | Dan Timoney <dtimoney@att.com> | 2017-10-12 09:04:22 -0400 |
---|---|---|
committer | Dan Timoney <dtimoney@att.com> | 2017-10-12 09:04:22 -0400 |
commit | adef520003cc54ae60fc62154df8caacb0610243 (patch) | |
tree | 414084e9852702af72d6bb4aec84c9a6d076c10c /docs/release-notes.rst | |
parent | 73d1bd7ab120c112f0febbcfa5b549be7e9754ea (diff) |
Add readthedocs documentation for sli/northbound
Add readthedocs documentation for sli/northbound.
Change-Id: I8ca9d7e839408094ab3754500d71fe7463f0b0e4
Issue-ID: CCSDK-107
Signed-off-by: Dan Timoney <dtimoney@att.com>
Diffstat (limited to 'docs/release-notes.rst')
-rw-r--r-- | docs/release-notes.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..21ff338c --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,45 @@ +.. 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** + |