From c17a93af02167e5521945ce4c54be5c64a305a0f Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Mon, 24 Jul 2017 00:40:37 +0000 Subject: [PATCH] Cleanup release notes The main purpose of prelude is to describe release highlights. The current usage of prelude looks random and there is no need for individual release notes to use prelude section. This commit cleans them up. Also add a note on this to the contributor guide. Change-Id: Ib72a3f4fc1bac2befd900249d07f5d67a56079f3 --- doc/source/contributor/contributing.rst | 8 ++++++-- .../notes/gb-to-gib-conversion-8a91839030a2f570.yaml | 7 +++---- .../global-class-name-convention-71ff68913c39b800.yaml | 10 ++++------ 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 73e669e763..4ab8c4bd77 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -606,8 +606,12 @@ If the following applies to the patch, a release note is required: 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. +.. note:: + + * A release note is suggested if a long-standing or important bug is fixed. + Otherwise, a release note is not required. + * It is not recommended that individual release notes use **prelude** + section as it is for release highlights. Horizon uses `reno `_ to generate release notes. Please read the docs for details. In summary, use diff --git a/releasenotes/notes/gb-to-gib-conversion-8a91839030a2f570.yaml b/releasenotes/notes/gb-to-gib-conversion-8a91839030a2f570.yaml index 9b52a795e8..00b7c7f3ae 100644 --- a/releasenotes/notes/gb-to-gib-conversion-8a91839030a2f570.yaml +++ b/releasenotes/notes/gb-to-gib-conversion-8a91839030a2f570.yaml @@ -1,9 +1,8 @@ --- -prelude: > - Cinder defines storage size in gibibytes (GiB), which is inconsistent with - Horizon panels that show/request storage size in gigabytes (GB). features: - - All Volume related panels in Horizon that previously used the term "GB" and + - Cinder defines storage size in gibibytes (GiB), which is inconsistent with + Horizon panels that show/request storage size in gigabytes (GB). + All Volume related panels in Horizon that previously used the term "GB" and "gigabyte" have been replaced with 'GiB' and 'gibibyte'. issues: - There are also some Nova related panels (e.g. "Instances") that reference diff --git a/releasenotes/notes/global-class-name-convention-71ff68913c39b800.yaml b/releasenotes/notes/global-class-name-convention-71ff68913c39b800.yaml index b2f1952ce4..b26ab81091 100644 --- a/releasenotes/notes/global-class-name-convention-71ff68913c39b800.yaml +++ b/releasenotes/notes/global-class-name-convention-71ff68913c39b800.yaml @@ -1,10 +1,8 @@ --- -prelude: > - In an effort to standarize our HTML class naming - conventions, we will be updating various class - names to use dashes, instead of underscore or - camelcasing, to match with Bootstrap's convention. deprecations: - - All instances of HTML class 'd3_pie_chart_usage' to 'pie-chart-usage'. + - In an effort to standarize our HTML class naming conventions, + we will be updating various class names to use dashes, instead of + underscore or camelcasing, to match with Bootstrap's convention. + All instances of HTML class 'd3_pie_chart_usage' to 'pie-chart-usage'. All instances of HTML class 'd3_pie_chart_distribution' to 'pie-chart-distribution'.