Merge pull request #79405 from ShaunaDiaz/OSDOCS-11452

OSDOCS-11452: refactor Getting started title MicroShift

Author: ShaunaDiaz

_attributes/attributes-microshift.adoc

@@ -6,6 +6,8 @@
 :OCP: OpenShift Container Platform
 :ocp-version: 4.17
 :oc-first: pass:quotes[OpenShift CLI (`oc`)]
+//OpenShift Kubernetes Engine
+:oke: OpenShift Kubernetes Engine
 :product-title-first: Red Hat build of MicroShift (MicroShift)
 :microshift-short: MicroShift
 :product-registry: OpenShift image registry

_topic_maps/_topic_map_ms.yml

@@ -22,29 +22,20 @@
 # topic groups and topics on the main page.
 
 ---
-Name: About
+Name: Understanding MicroShift
 Dir: microshift_welcome
 Distros: microshift
 Topics:
-- Name: Welcome
+- Name: Understanding Red Hat build of MicroShift
   File: index
 ---
-Name: Release notes
+Name: Red Hat build of MicroShift release notes
 Dir: microshift_release_notes
 Distros: microshift
 Topics:
 - Name: Red Hat build of MicroShift 4.17 release notes
   File: microshift-4-17-release-notes
 ---
-Name: Getting started
-Dir: microshift_getting_started
-Distros: microshift
-Topics:
-- Name: Understanding Red Hat build of MicroShift
-  File: microshift-understanding
-- Name: Architecture
-  File: microshift-architecture
----
 Name: Installing
 Dir: microshift_install
 Distros: microshift

microshift_getting_started/_attributes

@@ -1,25 +1,56 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="microshift-welcome-index"]
-= {product-title} {product-version} Documentation
+[id="microshift-understanding"]
+= Understanding {product-title}
 include::_attributes/attributes-microshift.adoc[]
-:context: microshift-welcome-index
+:context: microshift-understanding
+
+toc::[]
 
 [.lead]
+
 Welcome to the official {product-title} {product-version} documentation, where you can learn about {microshift-short} and start exploring its features.
 
+[id="microshift-product-documentation_{context}"]
+== {microshift-short} product documentation
+
 To browse the {microshift-short} {product-version} documentation, use one of the following methods:
 
 * Use the navigation bars and links to browse.
 * Select the task that interests you from the contents of this Welcome page.
 
 To get started with {microshift-short}, use the following links:
 
-* xref:../microshift_getting_started/microshift-understanding.adoc#microshift-understanding[Understanding {product-title}]
-* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}]
+//text is in main assembly for the sake of cross references
 * xref:../microshift_release_notes/microshift-4-17-release-notes.adoc#microshift-4-17-release-notes[{product-title} release notes]
+* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}]
 
 For related information, use the following links:
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_device_edge/4/html/overview/device-edge-overview[Red Hat Device Edge overview]
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[RHEL for Edge documentation]
-* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation]
+* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[{OCP} documentation]
+
+include::modules/microshift-about.adoc[leveloffset=+1]
+
+include::modules/microshift-arch-design.adoc[leveloffset=+1]
+
+[id="microshift-openshift-apis_{context}"]
+== {microshift-short} OpenShift APIs
+
+In addition to standard Kubernetes APIs, {microshift-short} includes a small 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-k8s-apis.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../microshift_rest_api/index.adoc#api-index[API index]
+* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[{oke}]

microshift_getting_started/images

@@ -2,6 +2,7 @@
 //
 // microshift/understanding-microshift.adoc
 
+:_mod-docs-content-type: CONCEPT
 [id="con-about-microshift_{context}"]
 = About {product-title}
 

microshift_getting_started/microshift-understanding.adoc

@@ -1,14 +1,8 @@
-:_mod-docs-content-type: ASSEMBLY
-[id="microshift-architecture"]
-= Architecture
-include::_attributes/attributes-microshift.adoc[]
-include::_attributes/common-attributes.adoc[]
-:context: microshift-architecture
-
-toc::[]
-
-Learn the specifics of {product-title} architecture including design intent, how it differs from {oke}, and API compatibility.
+// Module included in the following assemblies:
+//
+// microshift/understanding-microshift.adoc
 
+:_mod-docs-content-type: CONCEPT
 [id="microshift-architectural-design_{context}"]
 == Architectural design
 {microshift-short} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. Because {microshift-short} is primarily a platform for deploying applications, only the APIs and features essential to operating in edge and small form factor computing environments are included.
@@ -57,25 +51,4 @@ The figure "{product-title} differences from {oke}" shows that {oke} has the sam
 * Cloud Integration
 * Virtual Machines (VMs) through {VirtProductName}
 
-In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system.
-
-[id="microshift-openshift-apis_{context}"]
-== {microshift-short} OpenShift APIs
-
-In addition to standard Kubernetes APIs, {microshift-short} includes a small 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-k8s-apis.adoc[leveloffset=+1]
-
-[role="_additional-resources"]
-.Additional resources
-* xref:../microshift_rest_api/index.adoc#api-index[API index]
-* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[{oke}]
+In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system.