diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 10 | ||||
| -rw-r--r-- | docs/release-notes.rst | 55 | ||||
| -rw-r--r-- | docs/release-notes/bug-fixes.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/index.rst | 15 | ||||
| -rw-r--r-- | docs/release-notes/known-issues.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/new-features.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/security-issues.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/upgrade-notes.rst | 4 |
8 files changed, 60 insertions, 40 deletions
diff --git a/docs/index.rst b/docs/index.rst index 692003c..7a853ee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,14 +1,14 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. Holmes ------------------------------------------------- +------ -This document is aimed to give the users some brief introductions on Holmes from different aspects. The users could find useful information, e.g. the architecuture, the APIs and the installation steps, etc. as well as the release notes of Holmes in this document. +This document is aimed to give the users some brief introductions on Holmes from different aspects. +The users could find useful information, e.g. the architecuture, the APIs and the installation steps, etc. +as well as the release notes of Holmes in this document. .. toctree:: :maxdepth: 1 platform/index.rst - release-notes/index.rst - - + release-notes.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..20116e4 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,55 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Holmes Rule Management 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. + +Holmes provides alarm correlation and analysis for Telecom cloud infrastructure and services, +including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure +or degradation of services by digging into the ocean of events collected from different levels of +the Telecom cloud. + + +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** + +=========== + +End of Release Notes diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst deleted file mode 100644 index 4dc09fc..0000000 --- a/docs/release-notes/bug-fixes.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Bug Fixes ---------- diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst deleted file mode 100644 index 57f654f..0000000 --- a/docs/release-notes/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Release-notes -------------- - -Holmes provides alarm correlation and analysis for Telecom cloud infrastructure and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure or degradation of services by digging into the ocean of events collected from different levels of the Telecom cloud. - -.. toctree:: - :maxdepth: 1 - - new-features.rst - bug-fixes.rst - upgrade-notes.rst - security-issues.rst - known-issues.rst diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst deleted file mode 100644 index f4341d7..0000000 --- a/docs/release-notes/known-issues.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Known Issues ------------- diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst deleted file mode 100644 index f548910..0000000 --- a/docs/release-notes/new-features.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -New Features ------------- diff --git a/docs/release-notes/security-issues.rst b/docs/release-notes/security-issues.rst deleted file mode 100644 index 3a6cd9e..0000000 --- a/docs/release-notes/security-issues.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Security Issues ---------------- diff --git a/docs/release-notes/upgrade-notes.rst b/docs/release-notes/upgrade-notes.rst deleted file mode 100644 index 29e67e5..0000000 --- a/docs/release-notes/upgrade-notes.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Upgrade Notes -------------- |