diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-10 07:39:06 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-10 07:44:50 -0400 |
| commit | 7134cba7aa509a5ee7628244c52979e02807d252 (patch) | |
| tree | 01d4f737b6c3b27515bd8f116850f838b7cc6830 /docs/templates/sections/release-notes.rst | |
| parent | 2f3328219820a4be426981282350034b21e2e3f3 (diff) | |
Improve templates and add references in guides
See description of DOC-101
Added multipple conf.py files to test themes and multiple versions
Created initial structure for references in developer architecture guide and release notes
Change-Id: I7affcd1cb0258bef7cebe357a938080abe419693
Issue-ID: DOC-101
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/sections/release-notes.rst')
| -rw-r--r-- | docs/templates/sections/release-notes.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/templates/sections/release-notes.rst b/docs/templates/sections/release-notes.rst new file mode 100644 index 000000000..ca257314e --- /dev/null +++ b/docs/templates/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** + +=========== |