neutron/releasenotes/source
OpenStack Release Bot 4d3e4542f4 Update reno for stable/rocky
Change-Id: I8e74912b46e7c8ebc1dec964f4598519d32c826e
2018-08-09 21:54:37 +00:00
..
_static Add reno for release notes management 2015-11-04 22:27:56 +00:00
_templates Add reno for release notes management 2015-11-04 22:27:56 +00:00
locale Imported Translations from Zanata 2018-03-03 06:08:46 +00:00
conf.py Remove setting of version/release from releasenotes 2017-11-17 07:19:31 +00:00
index.rst Update reno for stable/rocky 2018-08-09 21:54:37 +00:00
liberty.rst reno: Remove remote names from branch specifiers 2018-02-22 15:39:47 +09:00
mitaka.rst reno: Remove remote names from branch specifiers 2018-02-22 15:39:47 +09:00
newton.rst reno: Remove remote names from branch specifiers 2018-02-22 15:39:47 +09:00
ocata.rst reno: Remove remote names from branch specifiers 2018-02-22 15:39:47 +09:00
pike.rst releasenotes: Move Pike ignore-notes to a proper file 2017-08-12 01:43:47 +09:00
queens.rst Update reno for stable/queens 2018-02-09 16:36:32 +00:00
README.rst Do not use prelude section for individual release notes 2017-08-04 07:17:52 +00:00
rocky.rst Update reno for stable/rocky 2018-08-09 21:54:37 +00:00
unreleased.rst releasenotes: Move Pike ignore-notes to a proper file 2017-08-12 01:43:47 +09:00

Neutron Release Notes Howto

Release notes are a new feature for documenting new features in OpenStack projects. Background on the process, tooling, and methodology is documented in a mailing list post by Doug Hellmann.

Writing release notes

For information on how to create release notes, please consult the reno documentation.

Please keep the following in your mind when you write release notes.

  • Avoid using "prelude" section for individual release notes. "prelude" section is for general comments about the release.
  • Use one entry per section (like "feature" or "upgrade"). All entries which belong to a same release will be merged and rendered, so there is less meaning to use multiple entries by a single topic.

Maintaining release notes

Warning

Avoid modifying an existing release note file even though it is related to your change. If you modify a release note file of a past release, the whole content will be shown in a latest release. The only allowed case is to update a release note in a same release.

If you need to update a release note of a past release, edit a corresponding release note file in a stable branch directly.