Fix formatting in release notes files 03/14903/2
authorAnil Belur <abelur@linuxfoundation.org>
Wed, 13 Mar 2019 01:41:51 +0000 (11:41 +1000)
committerTrevor Bramwell <tbramwell@linuxfoundation.org>
Wed, 13 Mar 2019 03:49:43 +0000 (20:49 -0700)
The change I04af514bbb237f405eb1d31ec10e3f019c85a43e breaks the rtd
verify job[1] because of the incorrect formating of the prelude section.

The prelude section can not contain a list as all prelude section are
concatenated together when the release notes are built. Merging the
preludes into their respective feature sections ensures the contex of
the comments are preserved as otherwise they will appear at the top of
the documentation apart from any other information.

Ref: https://docs.openstack.org/reno/latest/user/examples.html

[1] https://jenkins.opendaylight.org/releng/job/lf-infra-global-jjb-rtd-verify-any/475/

Change-Id: I3d23679eb4740b5fdc22fc566811d06ac6128820
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
releasenotes/notes/custom-swap-size-864fc8ca8343d4af.yaml
releasenotes/notes/pre-existing-work-volume-05af4e8546facbea.yaml

index 9ff6a47..ab95bf9 100644 (file)
@@ -1,11 +1,9 @@
 ---
-prelude:
-  - |
-    Previously the swap size was fixed at 1GB.
 features:
   - |
-    If the environmental variable 'SWAP_SIZE' is set when the
-    'init.sh' script is called, then a 'SWAP_SIZE' GB swap space will
-    be configured. If 'SWAP_SIZE' is '0' or is not a valid integer,
-    then no swap space is cofigured. If it is unset then 1GB of swap
-    will be configured.
+    **jenkins-init-scripts** If the environmental variable 'SWAP_SIZE' is
+    set when the 'init.sh' script is called, then a 'SWAP_SIZE' GB swap
+    space will be configured. If 'SWAP_SIZE' is '0' or is not a valid
+    integer, then no swap space is configured. If it is unset then 1GB
+    of swap will be configured. Previously the swap size was fixed at
+    1GB.
index b09c101..df6ff34 100644 (file)
@@ -1,9 +1,6 @@
 ---
-prelude:
-  - |
-    The work directory (/w) was created in the '/' volume. The ownership was
-    set to 'jenkins:jenkins'.
 features:
   - |
-    If the work directory or volume (/w) aleady exists, the ownership will be
-    recursivly set to 'jenkins:jenkins'.
+    **jenkins-init-scripts** If the work directory or volume (/w) aleady
+    exists, the ownership will be recursivly set to 'jenkins:jenkins'.
+    Previously only the top directory /w was owned by 'jenkins:jenkins'