Simplify and clarify features/behaviors sections 72/90272/1
authorJamo Luhrsen <jluhrsen@gmail.com>
Wed, 17 Jun 2020 20:00:35 +0000 (13:00 -0700)
committerJamo Luhrsen <jluhrsen@gmail.com>
Wed, 17 Jun 2020 20:05:44 +0000 (20:05 +0000)
This will hopefully make a little more clear what people
should include in which section around new or changed
features and behaviors.

Signed-off-by: Jamo Luhrsen <jluhrsen@gmail.com>
Change-Id: Ia8a552081bd86d60afba071398121a3b80c06425

docs/release-notes/sample-release-notes.rst

index 7983eb2ea36f6090850aa2bab101cac8f3084c9a..1649bda7aed224ef9c7f5faebf4672fde0e312e9 100644 (file)
@@ -28,17 +28,19 @@ Overview
 The overview section is for users to identify and describe the features
 that will be used by end-users (remove this paragraph).
 
-Behavior Changes
-================
+Behavior/Feature Changes
+========================
 
 This release introduces the following behavior changes:
 
 *
 
-New and Modified Features
-=========================
+New Features
+============
+
+This release provides the following new features:
 
-This release provides the following new and modified features:
+*
 
 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sample.git;a=blob;f=features/src/main/features/features.xml
 * **Feature Description:**  This sample feature performs various sample tasks
@@ -50,8 +52,8 @@ This release provides the following new and modified features:
 
 .. note::
 
-   this could be a karaf feature or a feature in general that has been
-   added/modified during the release cycle.
+   this could be a karaf feature or new functionality made available
+   as a new implementation of an already exisiting karaf feature.
 
 Deprecated Features
 ===================