Add eman carbon release notes

Change-Id: If91660108657928dd16de2b90a5ee7071b41a6f8
Signed-off-by: fsandoval <francisrsandoval@gmail.com>

diff --git a/docs/developer-guide/eman-developer-guide.rst b/docs/developer-guide/eman-developer-guide.rst
index f89cbd0307737d3649c4427fef8c1d5a3f00efe4..11198775e81050a32ca89e99a24e21cff90ef175 100644 (file)
--- a/docs/developer-guide/eman-developer-guide.rst
+++ b/docs/developer-guide/eman-developer-guide.rst
@@ -1,3 +1,5 @@
+.. _eman-dev-guide:
+
 eman Developer Guide
 ====================
 

diff --git a/docs/getting-started-guide/project-release-notes/eman.rst b/docs/getting-started-guide/project-release-notes/eman.rst
new file mode 100644 (file)
index 0000000..ec9a2ce
--- /dev/null
+++ b/docs/getting-started-guide/project-release-notes/eman.rst
@@ -0,0 +1,102 @@
+====
+eman
+====
+
+Major Features
+==============
+
+odl-eman
+--------
+
+* **Feature URL:**  https://git.opendaylight.org/gerrit/gitweb?p=eman.git;a=blob;f=features/features-eman/src/main/features/features.xml;hb=stable/carbon
+* **Feature Description:**  This provides a Northbound API to the eman Information Model
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** none
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`eman-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`eman-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  While eman does not expose other external interfaces, it does rely upon the
+  external interfaces exposed by the SNMP plugin.
+
+* Other security issues?
+
+  None
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report -  <https://sonar.opendaylight.org/overview?id=69960>`_
+* Link to CSIT Jobs -  No CSIT jobs for this experimental release
+* Other manual testing and QA information - Manual testing via RESTCONF and DLUX
+* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
+
+  Testing has been manual interaction via DLUX using an SNMP simulator as described in :ref:`eman-user-guide`.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  N/A as this is first release
+
+Compatiblity
+------------
+
+N/A as this is first release
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  N/A as this is first release
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  no known issues
+
+* Link to Open Bugs
+
+  no open bugs
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  N/A as this is first release
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  * `IETF Energy Management (eman) standards. <https://datatracker.ietf.org/wg/eman/charter/>`_
+    Only powerMeasurement table currently implemented.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Eman:Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  None

diff --git a/docs/user-guide/eman-user-guide.rst b/docs/user-guide/eman-user-guide.rst
index c207d18d4788b5612bd0565534cbe9351e3a1da8..77cd1ce387599e71d60abbd8030799921949770a 100644 (file)
--- a/docs/user-guide/eman-user-guide.rst
+++ b/docs/user-guide/eman-user-guide.rst
@@ -1,3 +1,5 @@
+.. _eman-user-guide:
+
 eman User Guide
 ===============