From 4f61f951fd2d5988a33ce2e8b630d04671896c7e Mon Sep 17 00:00:00 2001 From: Niall Bunting Date: Mon, 20 Jun 2016 10:54:15 +0000 Subject: [PATCH] Add documentation about generating release notes This adds a section about generating release notes to the glance documentation. So we can point people there if they need to add some release notes to their patch. Change-Id: I5756fcc6ff10cf88a2f3ad679f2e565a3c173a93 --- doc/source/contributing/documentation.rst | 26 +++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/source/contributing/documentation.rst b/doc/source/contributing/documentation.rst index a7b0d9cb30..37a8856f2f 100644 --- a/doc/source/contributing/documentation.rst +++ b/doc/source/contributing/documentation.rst @@ -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 + +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/``.