neutron/releasenotes/source
deepakmourya 9958853678 Remove setting of version/release from releasenotes
Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.

Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.

This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting
at
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html
.

Change-Id: I63745a207ba9123b34d2323d00b22e8cbdd253dd
2017-11-17 07:19:31 +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 Remove setting of version/release from releasenotes 2017-11-17 07:19:31 +00:00
index.rst Update reno for stable/pike 2017-08-11 08:59:15 +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 Remove release notes from reverted patch 2017-10-13 16:16:40 +02:00
pike.rst releasenotes: Move Pike ignore-notes to a proper file 2017-08-12 01:43:47 +09:00
README.rst Do not use prelude section for individual release notes 2017-08-04 07:17:52 +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.