openstack
/
ovn-octavia-provider
Code Issues Proposed changes
ovn-octavia-provider/releasenotes/source
History
Brian Haley 0f57bf525c Add release note README file 
Has instructions on how to run reno, and a link to the
openstack.org docs.  Copied from neutron.

Change-Id: Id38f6bb963cb04c7ba9ae0a0c10fac7b69b2613d
 		2020-04-24 14:07:27 -04:00
..
_static Initialize repository 2020-01-15 14:41:32 +00:00
_templates Initialize repository 2020-01-15 14:41:32 +00:00
README.rst Add release note README file 2020-04-24 14:07:27 -04:00
conf.py Initialize repository 2020-01-15 14:41:32 +00:00
index.rst Add release note README file 2020-04-24 14:07:27 -04:00
unreleased.rst Initialize repository 2020-01-15 14:41:32 +00:00
ussuri.rst Update master for stable/ussuri 2020-04-11 18:46:45 +00:00

README.rst

OVN Octavia Provider 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.