From 122bb77d330b80cc235a301f846d3f8f37821702 Mon Sep 17 00:00:00 2001 From: fsandoval Date: Tue, 16 May 2017 15:57:06 -0600 Subject: [PATCH] Add eman carbon release notes Change-Id: If91660108657928dd16de2b90a5ee7071b41a6f8 Signed-off-by: fsandoval --- docs/developer-guide/eman-developer-guide.rst | 2 + .../project-release-notes/eman.rst | 102 ++++++++++++++++++ docs/user-guide/eman-user-guide.rst | 2 + 3 files changed, 106 insertions(+) create mode 100644 docs/getting-started-guide/project-release-notes/eman.rst diff --git a/docs/developer-guide/eman-developer-guide.rst b/docs/developer-guide/eman-developer-guide.rst index f89cbd030..11198775e 100644 --- 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 index 000000000..ec9a2cef5 --- /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 - `_ +* 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. `_ + Only powerMeasurement table currently implemented. + +Release Mechanics +================= + +* `Link to 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 c207d18d4..77cd1ce38 100644 --- 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 =============== -- 2.36.6