From 6f1ecf24662b206e2ba580e8eb5fb6fcb551bf7e Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Fri, 4 Aug 2017 07:14:21 +0000 Subject: [PATCH] Exclude relnote from past releases from Pike relnotes reno includes release notes touched in a target release even if they are added from past releases. The recent release note cleanup I made as part of doc8 adoption and some other cleanup touched release notes from past releases. As a result, we see several number of release notes from past release in the Pike release notes unexpectedly. Also adds a warning note to the release notes howto page Change-Id: I127f96896488e9992d9309d76055b4883f6a62f3 Closes-Bug: #1708560 --- releasenotes/source/README.rst | 18 +++++++++++++++++- releasenotes/source/unreleased.rst | 8 +++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/releasenotes/source/README.rst b/releasenotes/source/README.rst index cdb8438f5ec..a926ea8db71 100644 --- a/releasenotes/source/README.rst +++ b/releasenotes/source/README.rst @@ -6,5 +6,21 @@ Release notes are a new feature for documenting new features in OpenStack projects. Background on the process, tooling, and methodology is documented in a `mailing list post by Doug Hellmann `_. +Writing release notes +--------------------- + For information on how to create release notes, please consult the -`Release Notes documentation `_. +`reno documentation `__. + +Maintaining release notes +------------------------- + +.. warning:: + + Avoid modifying an existing release note file even though it is related + to your change. If you modify a release note file of a past release, + the whole content will be shown in a latest release. The only allowed + case is to update a release note in a same release. + + If you need to update a release note of a past release, + edit a corresponding release note file in a stable branch directly. diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst index bd360bab3cf..befe0a33404 100644 --- a/releasenotes/source/unreleased.rst +++ b/releasenotes/source/unreleased.rst @@ -1,5 +1,7 @@ -============================= - Current Series Release Notes -============================= +============================ +Current Series Release Notes +============================ .. release-notes:: + :ignore-notes: + vlan-aware-vms-aka-trunk-3341cc75ba1bf5b4.yaml