010b133938
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 |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| conf.py | ||
| index.rst | ||
| liberty.rst | ||
| mitaka.rst | ||
| newton.rst | ||
| ocata.rst | ||
| README.rst | ||
| unreleased.rst | ||
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.