x/nova-dpm
Code Issues Proposed changes
Files
stable/ocata
nova-dpm/doc/source/devref.rst
Andreas Maier 0247163cf3 Addressed minor comments on 'overhauled docs' change. 
Details:
- Addressed the comments made on this change set:
  https://review.openstack.org/#/c/427346/4, as documented there.
- Changed TOC depth on main index page from 1 to 2.

Change-Id: I151d0605ce14a6771cee405d7b7f9661b15f27e4
Partial-Bug: 1660689
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
2017-02-10 09:46:33 +01:00

1.1 KiB
Raw Permalink Blame History

Developer Guide

Release Notes

Guidelines

  • Release note files MUST be part of the code changes which introduce the noteworthy behavior change. Noteworthy behavior changes are:
    • a deprecation of a config option
    • a change of the default value of a config option
    • the removal of a config option
    • upgrade relevant actions (e.g. new required config options)
    • security fixes
  • When important bug fixes or features are done, release note files COULD be part of those code changes.

How-To

To create a new release note:

$ reno --rel-notes-dir=doc/source/releasenotes/ new file-name-goes-here

To list existing release notes:

$ reno --rel-notes-dir=doc/source/releasenotes/ list .

To build the release notes:

$ tox -e docs

Note

If you build the release notes locally, please be aware that reno only scans release note files (*.yaml) which are committed in your local repository of this project.

More information about reno can be found at: http://docs.openstack.org/developer/reno/index.html