OSDOCS-12108: MicroShift 4.17 nits pass

2026-02-05 12:46:18 +01:00 · 2024-09-24 09:08:45 -04:00
parent 89e80b0f65
commit 314d28ab5e
17 changed files with 33 additions and 29 deletions
--- a/microshift_configuring/microshift-disable-lvms-csi-provider-csi-snapshot.adoc
+++ b/microshift_configuring/microshift-disable-lvms-csi-provider-csi-snapshot.adoc
@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-disable-lvms-csi-provider-csi-snapshot"]
-= Disabling LVMS CSI provider and CSI snapshot
+= Disabling the LVMS CSI provider or CSI snapshot
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-disable-lvms-csi-provider-csi-snapshot

--- a/microshift_configuring/microshift-using-config-tools.adoc
+++ b/microshift_configuring/microshift-using-config-tools.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-using-config-tools"]
-= Using the {microshift-short} configuration file
 include::_attributes/attributes-microshift.adoc[]
+= Using the {microshift-short} configuration file
 :context: microshift-configuring

 toc::[]
--- a/microshift_install_bootc/microshift-install-rhel-image-mode.adoc
+++ b/microshift_install_bootc/microshift-install-rhel-image-mode.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-install-rhel-image-mode"]
-= Using image mode for RHEL with {microshift-short}
 include::_attributes/attributes-microshift.adoc[]
+= Using image mode for RHEL with {microshift-short}
 :context: microshift-install-rhel-image-mode

 toc::[]
--- a/microshift_install_get_ready/microshift-fips.adoc
+++ b/microshift_install_get_ready/microshift-fips.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-microshift.adoc[]
 [id="microshift-fips"]
 = Using FIPS mode with {microshift-short}
-include::_attributes/attributes-microshift.adoc[]
 :context: microshift-fips

 toc::[]
--- a/microshift_install_get_ready/microshift-install-get-ready.adoc
+++ b/microshift_install_get_ready/microshift-install-get-ready.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-microshift.adoc[]
 [id="microshift-install-get-ready"]
 = Getting ready to install {microshift-short}
-include::_attributes/attributes-microshift.adoc[]
 :context: microshift-install-get-ready

 toc::[]
@@ -10,7 +10,7 @@ Plan for your {microshift-short} installation and complete host configuration st

 include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]

-[id="embed-offline-rhde-compatibility-table"]
+[id="get-ready-install-rhde-compatibility-table_{context}"]
 == Compatibility table

 Plan to pair a supported version of {op-system-ostree} with the {microshift-short} version you are using as described in the following compatibility table:
--- a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc
+++ b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-microshift.adoc[]
 [id="microshift-embed-in-rpm-ostree-for-offline-use"]
 = Embedding in a {op-system-ostree} image for offline use
-include::_attributes/attributes-microshift.adoc[]
 :context: microshift-embed-rpm-ostree-offline-use

 toc::[]
--- a/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc
+++ b/microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-microshift.adoc[]
 [id="microshift-embed-in-rpm-ostree"]
 = Embedding in a {op-system-ostree} image using image builder
-include::_attributes/attributes-microshift.adoc[]
 :context: microshift-embed-in-rpm-ostree

 toc::[]
--- a/microshift_running_apps/microshift-authentication.adoc
+++ b/microshift_running_apps/microshift-authentication.adoc
@@ -4,7 +4,7 @@
 include::_attributes/attributes-microshift.adoc[]
 :context: authentication-microshift

-== Understanding and managing pod security admission
+toc::[]

 Pod security admission is an implementation of the link:https://kubernetes.io/docs/concepts/security/pod-security-standards/[Kubernetes pod security standards]. Use pod security admission to restrict the behavior of pods.

--- a/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc
+++ b/microshift_running_apps/microshift-embedded-apps-on-rhel-edge.adoc
@@ -1,12 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-embedded-apps-on-rhel-edge"]
-= Options for embedding {microshift-short} applications in a RHEL for Edge image
+= Options for embedding applications in a RHEL for Edge image
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-embedded-apps-on-rhel-edge

 toc::[]

-You can embed microservices-based workloads and applications in a {op-system-ostree-first} image to run in a {microshift-short} cluster. Embedded applications can be installed directly on edge devices to run in air-gapped, disconnected, or offline environments.
+You can embed microservices-based workloads and applications in a {op-system-ostree-first} image to run in a {microshift-short} cluster. Embedded applications can be installed directly on edge devices to run in disconnected or offline environments.

 [id="microshift-add-app-RPMs-to-rpm-ostree-image_{context}"]
 == Adding application RPMs to an rpm-ostree image
--- a/microshift_running_apps/microshift-embedding-apps-tutorial.adoc
+++ b/microshift_running_apps/microshift-embedding-apps-tutorial.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-microshift.adoc[]
 [id="microshift-embedding-apps-tutorial"]
 = Embedding {microshift-short} applications tutorial
-include::_attributes/attributes-microshift.adoc[]
 :context: microshift-embedding-apps-tutorial

 toc::[]
--- a/microshift_storage/microshift-storage-migration.adoc
+++ b/microshift_storage/microshift-storage-migration.adoc
@@ -1,11 +1,11 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-storage-migration"]
-= Storage migration using the Kube Storage Version Migrator
+= Updating existing Kubernetes storage objects
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-storage-migration

 toc::[]

-Storage version migration is used to update existing objects in the cluster from their current version to the latest version. The Kube Storage Version Migrator embedded controller is used in {microshift-short} to migrate resources without having to recreate those resources. Either you or a controller can create a `StorageVersionMigration` custom resource (CR) that will request a migration through the Migrator Controller.
+Storage version migration is used to update existing objects in the cluster from their current version to the latest version. The Kube Storage Version Migrator embedded controller is used in {microshift-short} to migrate resources without having to recreate those resources. Either you or a controller can create a `StorageVersionMigration` custom resource (CR) that requests a migration through the Migrator Controller.

 include::modules/microshift-making-storage-migration-request.adoc[leveloffset=+1]
--- a/microshift_troubleshooting/microshift-cleanup-data.adoc
+++ b/microshift_troubleshooting/microshift-cleanup-data.adoc
@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-cleanup-data"]
-= Data cleanup
+= Cleaning up data with support
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-cleanup-data

@@ -14,7 +14,11 @@ Do not run this script without the guidance of product Support. Contact Support
 ====

 include::modules/microshift-data-cleaning-overview.adoc[leveloffset=+1]
+
 include::modules/microshift-data-cleaning-full-cleanup.adoc[leveloffset=+1]
+
 include::modules/microshift-data-cleaning-container-images.adoc[leveloffset=+1]
+
 include::modules/microshift-data-cleaning-ovn-data.adoc[leveloffset=+1]
+
 include::modules/microshift-data-cleaning-certs.adoc[leveloffset=+1]
--- a/microshift_updating/microshift-update-options.adoc
+++ b/microshift_updating/microshift-update-options.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-microshift.adoc[]
 [id="microshift-update-options"]
 = Update options with {product-title} and {op-system-bundle}
-include::_attributes/attributes-microshift.adoc[]
 :context: microshift-update-options

 toc::[]
--- a/microshift_updating/microshift-update-rpms-manually.adoc
+++ b/microshift_updating/microshift-update-rpms-manually.adoc
@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="microshift-update-rpms-manually"]
-= About updating {product-title} RPMs manually
+= About updating RPMs manually
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-update-rpms-manually

--- a/modules/microshift-making-storage-migration-request.adoc
+++ b/modules/microshift-making-storage-migration-request.adoc
@@ -4,9 +4,9 @@

 :_mod-docs-content-type: PROCEDURE
 [id="microshift-making-storage-migration-request_{context}"]
-= Making a storage migration request
+= Updating stored data to the latest storage version

-Storage migration is the process of updating stored data to the latest storage version, for example from `v1beta1` to `v1beta2`. To update your storage version, use the following procedure.
+Updating stored data to the latest Kubernetes storage version is called storage migration. For example, updating from `v1beta1` to `v1beta2` is migration. To update your storage version, use the following procedure.

 .Procedure

--- a/snippets/microshift-rhde-compatibility-table-snip.adoc
+++ b/snippets/microshift-rhde-compatibility-table-snip.adoc
@@ -11,7 +11,7 @@

 [cols="4",cols="~,~,~,20h"]
 |===
-^|*{op-system} Version(s)*
+^|*{op-system-base} Version(s)*
 ^|*{microshift-short} Version*
 ^|*{microshift-short} Release Status*
 ^|*Supported {microshift-short} Version{nbsp}&#8594;{nbsp}Version Updates*
--- a/snippets/microshift-update-paths-snip.adoc
+++ b/snippets/microshift-update-paths-snip.adoc
@@ -8,22 +8,22 @@
 [id="microshift-about-updates-checking-version-update-path_{context}"]
 = Checking the {microshift-short} version update path

-Before updating {microshift-short} or {op-system}, determine the compatibilities. Plan for the versions of each that you intend to use.
+Before updating {microshift-short} or {op-system-base}, determine the compatibilities. Plan for the versions of each that you intend to use.

 *{product-title} update paths*

 {microshift-short} version 4.17::
-* Version 4.17{nbsp}&#8594;{nbsp}4.17.z on {op-system} 9.4
+* Version 4.17{nbsp}&#8594;{nbsp}4.17.z on {op-system-base} 9.4

 {microshift-short} version 4.16::
-* Version 4.16{nbsp}&#8594;{nbsp}4.17 on {op-system} 9.4
-* Version 4.16{nbsp}&#8594;{nbsp}4.16.z on {op-system} 9.4
+* Version 4.16{nbsp}&#8594;{nbsp}4.17 on {op-system-base} 9.4
+* Version 4.16{nbsp}&#8594;{nbsp}4.16.z on {op-system-base} 9.4

 {microshift-short} version 4.15::
-* Version 4.15 on {op-system} 9.2 or 9.3{nbsp}&#8594;{nbsp}4.16 on {op-system} 9.4
-* Version 4.15{nbsp}&#8594;{nbsp}4.15.z on {op-system} 9.2 or 9.3
+* Version 4.15 on {op-system-base} 9.2 or 9.3{nbsp}&#8594;{nbsp}4.16 on {op-system-base} 9.4
+* Version 4.15{nbsp}&#8594;{nbsp}4.15.z on {op-system-base} 9.2 or 9.3

 {microshift-short} version 4.14::
-* Version 4.14 on {op-system} 9.2 or 9.3{nbsp}&#8594;{nbsp}4.16 on {op-system} 9.4
-* Version 4.14{nbsp}&#8594;{nbsp}4.15 on {op-system} 9.2 or 9.3
-* Version 4.14{nbsp}&#8594;{nbsp}4.14.z on {op-system} 9.2 or 9.3
+* Version 4.14 on {op-system-base} 9.2 or 9.3{nbsp}&#8594;{nbsp}4.16 on {op-system-base} 9.4
+* Version 4.14{nbsp}&#8594;{nbsp}4.15 on {op-system-base} 9.2 or 9.3
+* Version 4.14{nbsp}&#8594;{nbsp}4.14.z on {op-system-base} 9.2 or 9.3