openstack/glance
Code Issues Proposed changes

Merge "Add documentation about generating release notes"

Browse Source
This commit is contained in:
Jenkins 2016-06-21 16:11:34 +00:00 committed by Gerrit Code Review
commit 07608518e9
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/contributing/documentation.rst
View File

@ -38,3 +38,29 @@ which you may want to contribute:
There are some Glance-related API quick-reference guides published by the
OpenStack Documentation Team. Please see the README in their code repository
for more information: https://github.com/openstack/api-site
Release Notes
-------------
Release notes are notes available for operators to get an idea what each
project has included and changed during a cycle. They may also include
various warnings and notices.
Generating release notes is done with Reno.
.. code-block:: bash
$ tox -e venv -- reno new <bug-,bp-,whatever>
This will generate a yaml file in ``releasenotes/notes`` that will contain
instructions about how to fill in (or remove) the various sections of
the document. Modify the yaml file as appropriate and include it as
part of your commit.
Once the release notes have been committed you can build them by using:
.. code-block:: bash
$ tox -e releasenotes
This will create the HTML files under ``releasenotes/build/html/``.