From f9adca0e0cca042b88d3a03248f6786b0903ef51 Mon Sep 17 00:00:00 2001 From: Stuart McLaren Date: Tue, 26 Jul 2016 14:25:24 +0000 Subject: [PATCH] Minor tweak to release note documentation Make it a little clearer that you need to add the release note to git before running 'tox -ereleasenotes'. Change-Id: Ia822be3b4024886072fc08600270297ab6a81cba --- doc/source/contributing/documentation.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/contributing/documentation.rst b/doc/source/contributing/documentation.rst index e24ffe130d..ea4f7ed74a 100644 --- a/doc/source/contributing/documentation.rst +++ b/doc/source/contributing/documentation.rst @@ -70,6 +70,12 @@ 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. +Commit your note to git (required for reno to pick it up): + +.. code-block:: bash + + $ git add releasenotes/notes/; git commit + Once the release notes have been committed you can build them by using: .. code-block:: bash