docs/release-notes/sample-release-notes.rst

   1 ===================
   2 About this Document
   3 ===================
   4
   5 This document is a verbatim copy of the `Project Lifecycle &0 Releases Document
   6 <http://www.opendaylight.org/project-lifecycle-releases#MatureReleaseProcess>`
   7 section, which has information about the release review document.
   8
   9 Both the release plan and release review document are intended to be short and
  10 simple. They are both posted publicly on the ODL wiki to assist in project
  11 coordination.
  12
  13 .. important::
  14
  15    When copying, remove the entire "About this Document" section and
  16    fill out the next sections. In addition, do not remove any section.
  17    Also, use short sentences and not "n/a" or "none," since it is
  18    confusing to the reader as to whether that means there are
  19    no issues or you did not address the issue.
  20
  21 ============
  22 Project Name
  23 ============
  24
  25 Overview
  26 ========
  27
  28 The overview section is for users to identify and describe the features
  29 that will be used by end-users (remove this paragraph).
  30
  31 Behavior/Feature Changes
  32 ========================
  33
  34 This release introduces the following behavior changes:
  35
  36 *
  37
  38 New Features
  39 ============
  40
  41 This release provides the following new features:
  42
  43 *
  44
  45 .. note::
  46
  47    this could be a karaf feature or new functionality made available
  48    as a new implementation of an already existing karaf feature.
  49
  50 Deprecated Features
  51 ===================
  52
  53 This release removed the following features:
  54
  55 *
  56
  57 Resolved Issues
  58 ===============
  59
  60 The following table lists the resolved issues fixed this release.
  61
  62 .. list-table::
  63    :widths: 15 55
  64    :header-rows: 1
  65
  66    * - **Key**
  67      - **Summary**
  68
  69    * - <bug ID>
  70      -
  71
  72 Known Issues
  73 ============
  74
  75 The following table lists the known issues that exist in this release.
  76
  77 .. list-table::
  78    :widths: 15 55
  79    :header-rows: 1
  80
  81    * - **Key**
  82      - **Summary**
  83
  84    * - <bug ID>
  85      -