apply suggestions

gabrielcocenza · Mar 21, 2024 · 5a59540 · 5a59540
1 parent 51dccc4
commit 5a59540
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 15 deletions.
diff --git a/docs/.custom_wordlist.txt b/docs/.custom_wordlist.txt
@@ -6,7 +6,6 @@ Github
 frictionless
 COU
 cou
-colocated
 COUModel
 SIGINT
 SIGINTs
@@ -16,7 +15,6 @@ STDOUT
 juju
 libjuju
 VPN
-VMs
 ctrl
 snapcraft
 OpenStackApplication

diff --git a/docs/how-to/plan-upgrade.rst b/docs/how-to/plan-upgrade.rst
@@ -89,10 +89,11 @@ To generate a plan targeting the **data-plane** applications use:
     cou plan data-plane
 
 **Note:**
+
 - It's essential to complete the upgrade of the **control-plane** components before being able to
 generate a plan for the **data-plane**.
-- By default, this command will skip hypervisors from the planning that have VMs running. See the
-`Plan for non-empty hypervisors`_ section to include them.
+- By default, this command will skip hypervisors that have VMs running from the planning. See the
+`Plan for non-empty hypervisors`_ section for instructions on how to include them.
 
 
 Plan for the hypervisors
@@ -114,14 +115,15 @@ It's also possible to target for specific Juju **availability-zones** or **machi
     # plan for all empty hypervisors that are into zone-1
     cou plan hypervisors --availability-zone=zone-1
 
-**Note:**:
+**Note:**
+
 - Those specific filters are mutually exclusive, meaning that it's not possible
 to use them together.
 - Since **hypervisors** comprise a subset of **data-plane** components, it is
 also necessary to complete the upgrade of the **control-plane** components before
-being able to generate a plan for the **hypervisors**.
-- By default, this command will skip hypervisors from the planning that have VMs running. See the
-`Plan for non-empty hypervisors`_ section to include them.
+the **hypervisors** can be upgraded.
+- By default, this command will skip hypervisors that have VMs running from the planning . See the
+`Plan for non-empty hypervisors`_ section for instructions on how to include them.
 
 
 Plan for non-empty hypervisors

diff --git a/docs/how-to/upgrade-cloud.rst b/docs/how-to/upgrade-cloud.rst
@@ -43,10 +43,11 @@ To run an upgrade targeting the **data-plane** applications use:
     cou upgrade data-plane
 
 **Note:**
+
 - It's essential to complete the upgrade of the **control-plane** components before
 being able to upgrade the **data-plane**.
 - By default, this command will not upgrade hypervisors that have VMs running. See the
-`Upgrade non-empty hypervisors`_ section to include them.
+`Upgrade non-empty hypervisors`_ section for instructions on how to include them.
 
 
 Run upgrade for the hypervisors
@@ -69,13 +70,14 @@ It's also possible to target for specific Juju **availability-zones** or **machi
     cou upgrade hypervisors --availability-zone=zone-1
 
 **Note:**
+
 - Those specific filters are mutually exclusive, meaning that it's not possible
 to use them together.
 - Since **hypervisors** comprise a subset of **data-plane** components, it is
 also necessary to complete the upgrade of the **control-plane** components before
 the **hypervisors** can be upgraded.
 - By default, this command will not upgrade hypervisors that have VMs running. See the
-`Upgrade non-empty hypervisors`_ section to include them.
+`Upgrade non-empty hypervisors`_ section for instructions on how to include them.
 
 Upgrade non-empty hypervisors
 -----------------------------
@@ -204,8 +206,3 @@ Non-interactive and quiet mode:
     :input: cou upgrade --auto-approve --quiet
 
     Upgrade completed.
-
-
-.. LINKS
-.. _all-in-one: https://docs.openstack.org/charm-guide/latest/admin/upgrades/openstack.html#perform-the-upgrade
-.. _paused-single-unit: https://docs.openstack.org/charm-guide/latest/admin/upgrades/openstack.html#perform-the-upgrade