neutron/releasenotes/source
Akihiro Motoki 010b133938 Do not use prelude section for individual release notes
prelude section is prepared for general comments about a release [1].
At now neutron release notes use prelude section randomly.
Some rel notes use it and some do not.

This commit drop or move prelude section in Pike release notes.

In addition, some guideline on writing a release note
to the release notes howto page.

Change-Id: I53fefcc3eed30700d095c77d9e000319668097e8
2017-08-04 07:17:52 +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
conf.py releasenote: Specify openstackdocs as html_theme 2017-07-06 22:33:15 +00:00
index.rst Do not use prelude section for individual release notes 2017-08-04 07:17:52 +00:00
liberty.rst Add reno for release notes management 2015-11-04 22:27:56 +00:00
mitaka.rst Update reno for stable/mitaka 2016-03-19 15:13:58 +00:00
newton.rst Cleanup Newton Release Notes 2016-10-10 08:58:24 +02:00
ocata.rst Update reno for stable/ocata 2017-02-04 01:04:32 +00:00
README.rst Do not use prelude section for individual release notes 2017-08-04 07:17:52 +00:00
unreleased.rst Exclude relnote from past releases from Pike relnotes 2017-08-04 07:16:57 +00: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.