openstack/cinder
Code Issues Proposed changes
cinder/doc/source/contributor/releasenotes.rst
Jay S. Bryant 1423480fb6 Make doc/source directory compliant with design in spec 
The following spec defines what each project's doc/source
directory is supposed to look like:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory.  It also moves the CLI
related documentation into the 'cli' directory.  I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.

This patch also creates a template for future documentation
contribution.  I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.

The index file is updated to point at the new locations for
existing content.

'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.

Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
2017-07-19 15:59:02 -05:00

1.8 KiB
Raw Blame History

Release notes

The release notes for a patch should be included in the patch.

If the following applies to the patch, a release note is required:

  • Upgrades
    • The deployer needs to take an action when upgrading
    • A new config option is added that the deployer should consider changing from the default
    • A configuration option is deprecated or removed
  • Features
    • A new feature or driver is implemented
    • Feature is deprecated or removed
    • Current behavior is changed
  • Bugs
    • A security bug is fixed
    • A long-standing or important bug is fixed
  • APIs
    • REST API changes

Cinder uses reno to generate release notes. Please read the docs for details. In summary, use

$ tox -e venv -- reno new <bug-,bp-,whatever>

Then edit the sample file that was created and push it with your change.

To see the results:

$ git commit  # Commit the change because reno scans git log.

$ tox -e releasenotes

Then look at the generated release notes files in releasenotes/build/html in your favorite browser.