From 99d03686936dd1378e0d50289dd0ab8f0badcd8d Mon Sep 17 00:00:00 2001
From: Pierre Riteau <pierre@stackhpc.com>
Date: Wed, 6 Dec 2023 09:38:34 +0100
Subject: [PATCH] Clean up release notes for Bobcat

Change-Id: I96f00721c173cf095463424c0ca8779c54943591
---
 ...-custom-user-data-content-d188c7c197b50acb.yaml |  2 +-
 .../adds-nvidia-vgpu-support-b4c6f08a06c373c6.yaml |  6 +++---
 .../dellos10-support-ngs-24ba50803b4bf528.yaml     |  2 +-
 .../environment-dependencies-22df2a38a653425b.yaml |  4 ++--
 ...en-only-one-source-exists-5eb19c0f6b8820d5.yaml |  8 ++++----
 ...ature-merge-kolla-configs-99773e2f0af2ea4b.yaml |  3 +--
 ...or-ssh-args-for-bootstrap-ba894df14ba58167.yaml | 14 +++++++-------
 ...kolla-passwords-overrides-065fd6bb8eb9689d.yaml |  8 ++++----
 8 files changed, 23 insertions(+), 24 deletions(-)

diff --git a/releasenotes/notes/add-custom-user-data-content-d188c7c197b50acb.yaml b/releasenotes/notes/add-custom-user-data-content-d188c7c197b50acb.yaml
index 748e81c1..3dfc80b9 100644
--- a/releasenotes/notes/add-custom-user-data-content-d188c7c197b50acb.yaml
+++ b/releasenotes/notes/add-custom-user-data-content-d188c7c197b50acb.yaml
@@ -2,5 +2,5 @@
 features:
   - |
     Adds a new ``kolla_bifrost_deploy_image_user_data_content`` variable used
-    to define the custom user_data content used by the cloud-init for overcloud
+    to define custom ``user_data`` content used by cloud-init for overcloud
     provision.
diff --git a/releasenotes/notes/adds-nvidia-vgpu-support-b4c6f08a06c373c6.yaml b/releasenotes/notes/adds-nvidia-vgpu-support-b4c6f08a06c373c6.yaml
index b67cccf1..589a51ce 100644
--- a/releasenotes/notes/adds-nvidia-vgpu-support-b4c6f08a06c373c6.yaml
+++ b/releasenotes/notes/adds-nvidia-vgpu-support-b4c6f08a06c373c6.yaml
@@ -1,7 +1,7 @@
 ---
 features:
   - |
-    Adds initial support for configuring NVIDIA vGPUs. For more information please see
-    the `new documentation
-    <https://docs.openstack.org/kayobe/latest/configuration/reference/vgpu.yml>`_
+    Adds initial support for configuring NVIDIA vGPUs. For more information
+    please see the `new documentation
+    <https://docs.openstack.org/kayobe/latest/configuration/reference/vgpu.html>`_
     for this feature.
diff --git a/releasenotes/notes/dellos10-support-ngs-24ba50803b4bf528.yaml b/releasenotes/notes/dellos10-support-ngs-24ba50803b4bf528.yaml
index a659fb32..a54cfa3d 100644
--- a/releasenotes/notes/dellos10-support-ngs-24ba50803b4bf528.yaml
+++ b/releasenotes/notes/dellos10-support-ngs-24ba50803b4bf528.yaml
@@ -1,4 +1,4 @@
 ---
 features:
   - |
-    Adds support for using DellOS 10 switches with Networking Generic Switch.
+    Adds support for using Dell OS10 switches with Networking Generic Switch.
diff --git a/releasenotes/notes/environment-dependencies-22df2a38a653425b.yaml b/releasenotes/notes/environment-dependencies-22df2a38a653425b.yaml
index cf71fcc4..dc9d7d6f 100644
--- a/releasenotes/notes/environment-dependencies-22df2a38a653425b.yaml
+++ b/releasenotes/notes/environment-dependencies-22df2a38a653425b.yaml
@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Adds a experimental support for layering multiple environments using a
-    .kayobe-environment file.
+    Adds experimental support for layering multiple environments using a
+    ``.kayobe-environment`` file.
diff --git a/releasenotes/notes/fallback-to-templating-when-only-one-source-exists-5eb19c0f6b8820d5.yaml b/releasenotes/notes/fallback-to-templating-when-only-one-source-exists-5eb19c0f6b8820d5.yaml
index 6edcb55c..ee18f43c 100644
--- a/releasenotes/notes/fallback-to-templating-when-only-one-source-exists-5eb19c0f6b8820d5.yaml
+++ b/releasenotes/notes/fallback-to-templating-when-only-one-source-exists-5eb19c0f6b8820d5.yaml
@@ -1,7 +1,7 @@
 ---
 fixes:
   - |
-    When merging kolla config, fallback to templating when only one source file
-    exists. This allows you to use config that templates to invalid yaml/ini as
-    long as there isn't an environment override. This improves backwards
-    compatability where it was permitted to use such constructs.
+    When merging Kolla configuration, fallback to templating when only one
+    source file exists. This allows you to use configuration that templates to
+    invalid YAML/INI as long as there is no environment override. This improves
+    backwards compatibility where it was permitted to use such constructs.
diff --git a/releasenotes/notes/feature-merge-kolla-configs-99773e2f0af2ea4b.yaml b/releasenotes/notes/feature-merge-kolla-configs-99773e2f0af2ea4b.yaml
index 74f5773f..e6e68302 100644
--- a/releasenotes/notes/feature-merge-kolla-configs-99773e2f0af2ea4b.yaml
+++ b/releasenotes/notes/feature-merge-kolla-configs-99773e2f0af2ea4b.yaml
@@ -46,7 +46,6 @@ deprecations:
     * ``kolla_extra_placement``
     * ``kolla_extra_sahara``
 
-    Use of Kolla custom service configuration files in
-    ``etc/kayobe/kolla/config`` and
+    Kolla custom service configuration files in ``etc/kayobe/kolla/config`` and
     ``etc/kayobe/environments/<environment>/kolla/config`` should be used
     instead.
diff --git a/releasenotes/notes/honor-ssh-args-for-bootstrap-ba894df14ba58167.yaml b/releasenotes/notes/honor-ssh-args-for-bootstrap-ba894df14ba58167.yaml
index 527d9a17..43440864 100644
--- a/releasenotes/notes/honor-ssh-args-for-bootstrap-ba894df14ba58167.yaml
+++ b/releasenotes/notes/honor-ssh-args-for-bootstrap-ba894df14ba58167.yaml
@@ -2,12 +2,12 @@
 fixes:
   - |
     When determining whether or not a host needs bootstrapping, we attempt to
-    connect to the host using ansible_user, if the login fails, we then assume
-    that the host needs bootstrapping. In previous releases we used a manually
-    crafted ``ssh`` command. This did respect any customisations to the SSH
-    arguments made through ansible configuration.  We now use the raw module so
-    that these customisations are used when connecting to the host. One
-    possible use case is to configure a jump host between the control host and
-    the target hosts. If bootstrapping was needed, hosts will now show as
+    connect to the host using ``ansible_user``, if the login fails, we then
+    assume that the host needs bootstrapping. In previous releases we used a
+    manually crafted ``ssh`` command. This did not respect any customisations
+    to the SSH arguments made through Ansible configuration. We now use the raw
+    module so that these customisations are used when connecting to the host.
+    One possible use case is to configure a jump host between the control host
+    and the target hosts. If bootstrapping was needed, hosts will now show as
     unreachable in the summary stats at the end of the run. This can safely be
     ignored.
diff --git a/releasenotes/notes/kolla-passwords-overrides-065fd6bb8eb9689d.yaml b/releasenotes/notes/kolla-passwords-overrides-065fd6bb8eb9689d.yaml
index adc5318e..e66f0579 100644
--- a/releasenotes/notes/kolla-passwords-overrides-065fd6bb8eb9689d.yaml
+++ b/releasenotes/notes/kolla-passwords-overrides-065fd6bb8eb9689d.yaml
@@ -6,9 +6,9 @@ fixes:
     ``kolla_ansible_default_custom_passwords`` and own dictionary with custom
     passwords in configuration files. Now
     ``kolla_ansible_extra_custom_passwords`` should provide only user custom
-    passwords to add or override in the passwords.yml.
+    passwords to add or override in ``kolla/passwords.yml``.
 upgrade:
   - |
-    Now no need to combine ``kolla_ansible_default_custom_passwords`` and
-    ``kolla_ansible_custom_passwords`` in your custom configuration. Just use
-    ``kolla_ansible_extra_custom_passwords`` to add or override passwords.
+    Introduces a new variable ``kolla_ansible_extra_custom_passwords`` to avoid
+    the need to combine ``kolla_ansible_default_custom_passwords`` and
+    ``kolla_ansible_custom_passwords`` when adding or overriding passwords.
-- 
GitLab