| 1 |
=========================== |
| 2 |
Neutron Release Notes Howto |
| 3 |
=========================== |
| 4 |
|
| 5 |
Release notes are a new feature for documenting new features in |
| 6 |
OpenStack projects. Background on the process, tooling, and |
| 7 |
methodology is documented in a `mailing list post by Doug Hellmann <http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html>`_. |
| 8 |
|
| 9 |
Writing release notes |
| 10 |
--------------------- |
| 11 |
|
| 12 |
For information on how to create release notes, please consult the |
| 13 |
`reno documentation <https://docs.openstack.org/reno/latest/user/usage.html>`__. |
| 14 |
|
| 15 |
Please keep the following in your mind when you write release notes. |
| 16 |
|
| 17 |
* **Avoid using "prelude" section** for individual release notes. |
| 18 |
"prelude" section is for general comments about the release. |
| 19 |
* **Use one entry per section** (like "feature" or "upgrade"). |
| 20 |
All entries which belong to a same release will be merged and rendered, |
| 21 |
so there is less meaning to use multiple entries by a single topic. |
| 22 |
|
| 23 |
Maintaining release notes |
| 24 |
------------------------- |
| 25 |
|
| 26 |
.. warning:: |
| 27 |
|
| 28 |
Avoid modifying an existing release note file even though it is related |
| 29 |
to your change. If you modify a release note file of a past release, |
| 30 |
the whole content will be shown in a latest release. The only allowed |
| 31 |
case is to update a release note in a same release. |
| 32 |
|
| 33 |
If you need to update a release note of a past release, |
| 34 |
edit a corresponding release note file in a stable branch directly. |