Merge pull request #54793 from ShaunaDiaz/OSDOCS-4825

OSDOCS-4825: Copy edits and structural tweaks for MicroShift 4.12 docset

Author: skrthomas

_topic_maps/_topic_map_ms.yml

@@ -110,8 +110,6 @@ Distros: microshift
 Topics:
 - Name: Configuring
   File: microshift-using-config-tools
-- Name: Additional information
-  File: microshift-things-to-know
 ---
 Name: Networking
 Dir: microshift_networking
@@ -185,5 +183,7 @@ Distros: microshift
 Topics:
 - Name: Checking your version
   File: microshift-version
-- Name: Known issues
-  File: microshift-known-issues
+- Name: Additional information
+  File: microshift-things-to-know
+- Name: Troubleshooting
+  File: microshift-troubleshooting

microshift_configuring/microshift-using-config-tools.adoc

@@ -1,8 +1,9 @@
 :_content-type: ASSEMBLY
 [id="microshift-using-config-tools"]
-= Configuring
+= Using configuration tools
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-configuring
+
 toc::[]
 
 A YAML file customizes {product-title} instances with your preferences, settings, and parameters.

microshift_getting_started/microshift-architecture.adoc

@@ -8,13 +8,15 @@ toc::[]
 
 Learn the specifics of {product-title} architecture including design intent, how it differs from {OCP}, and API compatibility.
 
+[id="microshift-architectural-design_{context}"]
 == Architectural design
-{product-title} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. {product-title} contains only the APIs and features essential to operating in edge and small form factor computing environments.
+{product-title} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. {product-title} contains only the APIs and features essential to operating in edge and small form factor computing environments. The following operational differences from {OCP} can help you understand where {product-title} can be deployed:
 
+[id="microshift-differences-ocp_{context}"]
 == Key differences from {OCP}
 * Application-level events and metrics are observation-only
 * Devices with {product-title} installed are self-managing
-* Compatible with rpm-ostree-based systems
+* Compatible with RPM-OStree-based systems
 * Uses only the APIs needed for essential functions, such as security and runtime controls
 * Enables a subset of commands from the OpenShift CLI (`oc`) tool
 
@@ -25,6 +27,20 @@ Learn the specifics of {product-title} architecture including design intent, how
 // * Use several single-node deployments to ... (use case example)
 // Bullets need more specific detail
 
-include::modules/microshift-openshift-apis.adoc[leveloffset=+1]
+[id="microshift-openshift-apis_{context}"]
+== {product-title} OpenShift APIs
+
+In addition to the standard Kubernetes APIs, {product-title} includes a subset of the APIs supported by {OCP}.
+
+[cols="1,1",options="header"]
+|===
+^| API ^| API group
+| xref:../microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route]
+| route.openshift.io/v1
+| xref:../microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints]
+| security.openshift.io/v1
+|===
+
+include::modules/microshift-oc-apis-errors.adoc[leveloffset=+1]
 
 include::modules/microshift-k8s-apis.adoc[leveloffset=+1]

microshift_getting_started/microshift-understanding.adoc

@@ -1,12 +1,11 @@
 :_content-type: ASSEMBLY
 [id="con-microshift-understanding"]
-= Understanding MicroShift
+= Understanding {product-title}
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-understanding
 
 toc::[]
 
-Get an overview of what you can do with {product-title}, a distribution of {OCP} designed for optimizing small form factor devices and edge computing.
-
-include::modules/about-microshift.adoc[leveloffset=+1]
+Get an overview of what you can do with {product-title}, based on {OCP}, but designed for optimizing small form factor devices and edge computing.
 
+include::modules/microshift-about.adoc[leveloffset=+1]

microshift_install/microshift-embed-in-rpm-ostree.adoc

@@ -42,7 +42,7 @@ include::modules/microshift-adding-service-to-blueprint.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* For further customizations such as adding users, firewall rules, or kernel arguments to a blueprint, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/composing_installing_and_managing_rhel_for_edge_images/composing-a-rhel-for-edge-image-using-image-builder-command-line_composing-installing-managing-rhel-for-edge-images#image-customizations_composing-a-rhel-for-edge-image-using-image-builder-command-line[supported image customizations].
+* For further customizations such as adding users, firewall rules, or kernel arguments to a blueprint, refer to link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/composing_installing_and_managing_rhel_for_edge_images/composing-a-rhel-for-edge-image-using-image-builder-command-line_composing-installing-managing-rhel-for-edge-images#image-customizations_composing-a-rhel-for-edge-image-using-image-builder-command-line[supported image customizations].
 
 include::modules/microshift-adding-containers-to-blueprint.adoc[leveloffset=+2]
 include::modules/microshift-provisioning-ostree.adoc[leveloffset=+1]
@@ -54,8 +54,8 @@ include::modules/microshift-provisioning-ostree.adoc[leveloffset=+1]
 . xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[System requirements for installing {product-title}].
 . Red Hat Hybrid Cloud Console link:https://console.redhat.com/openshift/install/pull-secret[pull secret].
 . xref:../microshift_networking/microshift-networking.adoc#microshift-firewall-req-settings_microshift-networking[Required firewall settings].
-. link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/performing_an_advanced_rhel_8_installation/creating-kickstart-files_installing-rhel-as-an-experienced-user[Creating a kickstart file]
-. link:https://access.redhat.com/solutions/60959[How to embed a Kickstart file into an ISO image]
+. link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/performing_an_advanced_rhel_8_installation/creating-kickstart-files_installing-rhel-as-an-experienced-user[Creating a Kickstart file].
+. link:https://access.redhat.com/solutions/60959[How to embed a Kickstart file into an ISO image].
 
 include::modules/microshift-accessing.adoc[leveloffset=+1]
 include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]

microshift_install/microshift-install-rpm.adoc

@@ -3,6 +3,7 @@
 = Installing {product-title} from an RPM package
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-install-rpm
+
 toc::[]
 
 You can install {product-title} from an RPM package on a machine with {op-system-first} {op-system-version}.
@@ -13,7 +14,6 @@ Red Hat does not support an update path from Developer Preview and Technology Pr
 ====
 
 include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]
-
 include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
@@ -25,26 +25,22 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
 
 * xref:../microshift_configuring/microshift-using-config-tools.adoc#microshift-using-config-tools[Configuring MicroShift].
 
-* For more options on partition configuration, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/performing_a_standard_rhel_8_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
+* For more options on partition configuration, refer to link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/performing_a_standard_rhel_8_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
 
-* For more information about resizing your existing LVs to free up capacity in your VGs, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups]
+* For more information about resizing your existing LVs to free up capacity in your VGs, refer to link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups]
 
 include::modules/microshift-installing-from-rpm.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[system requirements for installing MicroShift] have been met.
+* xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[System requirements for installing MicroShift] have been met.
 
 * xref:../microshift_install/microshift-install-rpm.adoc#preparing-install-microshift-from-rpm-package_microshift-install-rpm[Preparing to install MicroShift from an RPM package].
 
 include::modules/microshift-service-starting.adoc[leveloffset=+1]
-
 include::modules/microshift-service-stopping.adoc[leveloffset=+1]
-
 include::modules/microshift-accessing.adoc[leveloffset=+1]
-
 include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
-
 include::modules/microshift-accessing-cluster-remotely-admin.adoc[leveloffset=+2]
-include::modules/microshift-accessing-cluster-remotely-non-admin.adoc[leveloffset=+2]
+include::modules/microshift-accessing-cluster-remotely-non-admin.adoc[leveloffset=+2]

microshift_networking/microshift-networking.adoc

@@ -29,9 +29,10 @@ include::modules/microshift-firewalld-install.adoc[leveloffset=+1]
 include::modules/microshift-firewall-req-settings.adoc[leveloffset=+1]
 include::modules/microshift-firewall-opt-settings.adoc[leveloffset=+1]
 include::modules/microshift-firewall-allow-traffic.adoc[leveloffset=+1]
+include::modules/microshift-firewall-apply-settings.adoc[leveloffset=+1]
 include::modules/microshift-firewall-verify-settings.adoc[leveloffset=+1]
 include::modules/microshift-firewall-known-issue.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* link:https://https://access.redhat.com/documentation/en-us/microshift/4.12/toubleshooting/index[Troubleshooting and known issues].
+* xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-version[Troubleshooting].

microshift_release_notes/microshift-4-12-release-notes.adoc

@@ -9,5 +9,3 @@ that they are relevant for.
 Release note changes should be added/edited in their own PR.
 
 This file is here to allow builds to work.
-
-//We do not have version branches yet. Stub for merge pending process clarification.

microshift_storage/container_storage_interface_microshift/microshift-persistent-storage-csi.adoc

@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="persistent-storage-csi-microshift"]
-= Configuring CSI volumes for MicroShift
+= Configuring CSI volumes for {product-title}
 include::_attributes/attributes-microshift.adoc[]
 :context: persistent-storage-csi-microshift
 
@@ -17,11 +17,7 @@ as persistent storage.
 ====
 
 include::modules/persistent-storage-csi-architecture.adoc[leveloffset=+1]
-
 include::modules/persistent-storage-csi-external-controllers.adoc[leveloffset=+2]
-
 include::modules/persistent-storage-csi-driver-daemonset.adoc[leveloffset=+2]
-
 include::modules/persistent-storage-csi-dynamic-provisioning.adoc[leveloffset=+1]
-
 include::modules/persistent-storage-csi-mysql-example.adoc[leveloffset=+1]

microshift_storage/dynamic-provisioning-microshift.adoc

@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="dynamic-provisioning-microshift"]
-= Dynamic provisioning for {product-title} 
+= Dynamic provisioning for {product-title}
 include::_attributes/attributes-microshift.adoc[]
 :context: dynamic-provisioning-microshift