From dbb05ae5d5077057f07163202eb050a7ee475639 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Tue, 20 Dec 2016 10:35:04 -0500 Subject: [PATCH] [doc] point release note docs to project team guide no point in maintaining our own doc, the project team guide (not to be confused with the other PTG) already documents when and how to create release notes. Change-Id: I894b335fbb1d4b16d1813c11c9dc912dcbf55bba --- .../devref/development_best_practices.rst | 42 +++---------------- 1 file changed, 6 insertions(+), 36 deletions(-) diff --git a/doc/source/devref/development_best_practices.rst b/doc/source/devref/development_best_practices.rst index 7d6b5fd327..e54c59d740 100644 --- a/doc/source/devref/development_best_practices.rst +++ b/doc/source/devref/development_best_practices.rst @@ -158,43 +158,13 @@ found in ``config-generator/keystone.conf``. Release Notes ============= -The release notes for a patch should be included in the patch. If not, the -release notes should be in a follow-on review. - -If the following applies to the patch, a release note is required: - -* The deployer needs to take an action when upgrading -* The backend driver interface changes -* A new feature is implemented -* Function was removed (hopefully it was deprecated) -* Current behavior is changed -* A new config option is added that the deployer should consider changing from - the default -* A security bug is fixed - -A release note is suggested if a long-standing or important bug is fixed. -Otherwise, a release note is not required. - -Keystone uses `reno `_ to -generate release notes. Please read the docs for details. In summary, use - -.. code-block:: bash - - $ tox -e venv -- reno new - -Then edit the sample file that was created and push it with your change. - -To see the results: - -.. code-block:: bash - - $ 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. +The Keystone team uses `reno `_ +to generate release notes. These are important user-facing documents that must +be included when a user-facing change is performed. A release note should be +included in the same patch the work is being performed. +For more information on how and when to create release notes, see the +`project-team-guide `_. Testing Keystone ================