openstack
/
neutron-tempest-plugin
Code Issues Proposed changes
neutron-tempest-plugin/releasenotes/source
History
Andreas Jaeger 7dc2857705 Switch to newer openstackdocstheme and reno versions 
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I02b83b2d2ffa7e007f8150176ac881a8b6a53495
 		2020-06-02 00:19:08 +00:00
..
_static Apply cookiecutter to newly split project 2017-09-07 22:23:55 +05:30
_templates Apply cookiecutter to newly split project 2017-09-07 22:23:55 +05:30
README.rst Add release notes job to zuul template 2018-09-13 15:26:04 -06:00
conf.py Switch to newer openstackdocstheme and reno versions 2020-06-02 00:19:08 +00:00
index.rst Sync Sphinx requirement 2019-06-19 22:58:47 +08:00
unreleased.rst Apply cookiecutter to newly split project 2017-09-07 22:23:55 +05:30

README.rst

Neutron Tempest Plugin 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.