Add the Release Note

[holmes/rule-management.git] / docs / release-notes.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 20116e4..32f4515 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -5,44 +5,30 @@
 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,
+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.
+the telecom cloud.
 
 
-Version: x.y.z
+Version: 1.0.0
 --------------
 
 
-:Release Date: yyyy-mm-dd
+:Release Date: 2017-11-16
 
 
 
 **New Features**
-
-One or two sentences explaining the purpose of this Release.
+In the Amsterdam release, Holmes is mainly intended to support the alarm correlation analysis for the VoLTE scenario. To get us there, Holmes provides the following features:
+       - `Rule Management <>`_ The feature provides interfaces for the users to create, query, update and delete rules. In this release, they are used along with the DCAE interfaces to accomplish the deployment (creation/update) of the control loop related rules. 
+       - `Engine Management <>`_ The feature is not exposed to the end user directly. It's mainly used internally by Holmes as a container for the execution of rules. It provides interface for rule verification and deployment/un-deployment.
 
 **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**