From a75ddd4112f2d7297ffa5aad45b450246dadcae5 Mon Sep 17 00:00:00 2001 From: Nikhil Komawar Date: Fri, 2 Sep 2016 12:39:07 -0400 Subject: [PATCH] Add note to docs on release notes prelude section This commit adds a note to the developer documentation for adding a note to the prelude section. It was mentioned in this change [1] that adding notes to the prelude section for those that are not significantly important isn't necessary. So, this commit adds a general notice so the docs about the same. [1] https://review.openstack.org/#/c/364586/ Co-Authored-By: Nikhil Komawar Co-Authored-By: Brian Rosmaita Change-Id: I0c507706ec39b5eafcdebfb3e1f57dc56976d9a5 --- doc/source/contributing/documentation.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/source/contributing/documentation.rst b/doc/source/contributing/documentation.rst index ea4f7ed74a..ffad2d2f60 100644 --- a/doc/source/contributing/documentation.rst +++ b/doc/source/contributing/documentation.rst @@ -51,7 +51,7 @@ which you may want to contribute: you notice structural improvements that our API reference is missing, please file a bug. And, of course, we would also welcome your patch implementing the improvement! - + Release Notes ------------- @@ -83,3 +83,11 @@ Once the release notes have been committed you can build them by using: $ tox -e releasenotes This will create the HTML files under ``releasenotes/build/html/``. + +**NOTE**: The ``prelude`` section in the release notes is to highlight only the +important changes of the release. Please word your note accordingly and be +judicious when adding content there. We don't encourage extraneous notes and at +the same time we don't want to miss out on important ones. In short, not every +release note will need content in the ``prelude`` section. If what you're +working on required a spec, then a prelude is appropriate. If you're submitting +a bugfix, most likely not; a spec-lite is a judgement call.