Merge pull request #52502 from dhellmann/microshift-poc-follow-up

kalexand-rh · web-flow · commit 3abbb9ddf60b · 2022-11-07T16:25:00.000-05:00
USHIFT-267: address comments from #50054
diff --git a/cli_reference/openshift_cli/usage-oc-kubectl.adoc b/cli_reference/openshift_cli/usage-oc-kubectl.adoc
@@ -16,11 +16,15 @@ Resources such as `DeploymentConfig`, `BuildConfig`, `Route`, `ImageStream`, and
 +
 * **Authentication**
 +
-The `oc` binary offers a built-in `login` command that allows authentication and enables you to work with {product-title} projects, which map Kubernetes namespaces to authenticated users.
 ifndef::microshift[]
+The `oc` binary offers a built-in `login` command for authentication and lets you work with {product-title} projects, which map Kubernetes namespaces to authenticated users.
 See xref:../../authentication/understanding-authentication.adoc#understanding-authentication[Understanding authentication] for more information.
 endif::[]
 +
+ifdef::microshift[]
+The `oc` binary offers a built-in `login` command for authentication to {product-title}.
+endif::[]
++
 * **Additional commands**
 +
 The additional command `oc new-app`, for example, makes it easier to get new applications started using existing source code or pre-built images. Similarly, the additional command `oc new-project` makes it easier to start a project that you can switch to as your default.
diff --git a/microshift_architecture/microshift-understanding.adoc b/microshift_architecture/microshift-understanding.adoc
@@ -5,17 +5,17 @@ include::_attributes/attributes-microshift.adoc[]
 :context: microshift-understanding
 toc::[]
 
-Learn about {product-title}, interacting with {product-title} the command-line interface (CLI) tools, consumption experience, and integration with {op-system-first}.
+Learn about {product-title}, interacting with {product-title} via the command-line interface (CLI) tools, and integration with {op-system-first}.
 
 [id="microshift-understanding-about_{context}"]
 == About MicroShift
 
-MicroShift is a distribution of {OCP} optimized for small form factor and edge computing.
+MicroShift is a distribution of {OCP} optimized for small form factors and edge computing.
 
-Edge devices deployed in the field pose very different operational, environmental, and business challenges from those of cloud computing. These challenges motivate different engineering trade-offs for Kubernetes at the far edge than for cloud or near-edge scenarios. MicroShift's design goals cater to this:
+Edge devices deployed in the field pose very different operational, environmental, and business challenges from those of cloud computing. These challenges motivate different engineering tradeoffs for Kubernetes at the far edge than for cloud or near-edge scenarios. MicroShift's design goals cater to these factors, including:
 
-* Make frugal use of system resources, such as CPU, memory, network, and storage
-* Tolerate severe networking constraints
-* Update securely, safely, quickly, and seamlessly, without disrupting workloads
-* Extend and integrate cleanly with edge-optimized operating systems, like Fedora IoT and {op-system-first}
-* Provide a consistent development and management experience with other distributions of {OCP}
+* Minimizing the use of system resources, such as CPU, memory, network, and storage
+* Tolerating severe networking constraints
+* Securely and seamlessly updating, without disrupting workloads
+* Extending and integrating cleanly with edge-optimized operating systems, like Fedora IoT and {op-system-first}
+* Providing a consistent development and management experience with other distributions of {OCP}
diff --git a/microshift_support/attributes b/microshift_support/attributes
@@ -1 +1 @@
-../../_attributes/
+../_attributes
diff --git a/microshift_support/images b/microshift_support/images
@@ -1 +1 @@
-../../images/
+../images
diff --git a/microshift_support/microshift-version.adoc b/microshift_support/microshift-version.adoc
@@ -5,44 +5,8 @@ include::_attributes/attributes-microshift.adoc[]
 :context: microshift-version
 toc::[]
 
-[id="microshift-version-cli"]
-== Checking the MicroShift Version from the command line
+Learn about detecting the version of {product-title} at runtime.
 
-From the command line, use `microshift version` to check the version information.
+include::modules/microshift-version-command-line.adoc[leveloffset=+1]
 
-[source,terminal]
-----
-$ microshift version
-----
-
-.Example output
-[source,terminal]
-----
-MicroShift Version: 4.10.0-0.microshift-e6980e25
-Base OCP Version: 4.10.18
-----
-
-[id="microshift-version-api"]
-== Checking the MicroShift Version via the API
-
-Through the API, access the `kube-public/microshift-version` ConfigMap to retrieve the same information.
-
-[source,terminal]
-----
-$ oc get configmap -n kube-public microshift-version -o yaml
-----
-
-.Example output
-[source,terminal]
-----
-apiVersion: v1
-data:
-  major: "4"
-  minor: "10"
-  version: 4.10.0-0.microshift-e6980e25
-kind: ConfigMap
-metadata:
-  creationTimestamp: "2022-08-08T21:06:11Z"
-  name: microshift-version
-  namespace: kube-public
-----
+include::modules/microshift-version-api.adoc[leveloffset=+1]
diff --git a/microshift_support/modules b/microshift_support/modules
@@ -1 +1 @@
-../../modules/
+../modules
diff --git a/microshift_support/snippets b/microshift_support/snippets
@@ -1 +1 @@
-../../snippets/
+../snippets/
diff --git a/modules/microshift-version-api.adoc b/modules/microshift-version-api.adoc
@@ -0,0 +1,30 @@
+// Module included in the following assemblies:
+//
+// * microshift_support/microshift-version.adoc
+
+[id="microshift-version-api"]
+= Checking the {product-title} Version via the API
+
+.Procedure
+
+* Using the API, access the `kube-public/microshift-version` ConfigMap to retrieve the same information.
+
+[source,terminal]
+----
+$ oc get configmap -n kube-public microshift-version -o yaml
+----
+
+.Example output
+[source,yaml]
+----
+apiVersion: v1
+data:
+  major: "4"
+  minor: "10"
+  version: 4.10.0-0.microshift-e6980e25
+kind: ConfigMap
+metadata:
+  creationTimestamp: "2022-08-08T21:06:11Z"
+  name: microshift-version
+  namespace: kube-public
+----
diff --git a/modules/microshift-version-command-line.adoc b/modules/microshift-version-command-line.adoc
@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * microshift_support/microshift-version.adoc
+
+[id="microshift-version-cli"]
+= Checking the {product-title} Version from the command-line
+
+.Procedure
+
+* Run the following command to check the version information:
+
+[source,terminal]
+----
+$ microshift version
+----
+
+.Example output
+[source,terminal]
+----
+MicroShift Version: 4.10.0-0.microshift-e6980e25
+Base OCP Version: 4.10.18
+----

Original file line number	Diff line number	Diff line change
@@ -16,11 +16,15 @@ Resources such as `DeploymentConfig`, `BuildConfig`, `Route`, `ImageStream`, and
`16`	`16`	`+`
`17`	`17`	`* Authentication`
`18`	`18`	`+`
`19`		-The `oc` binary offers a built-in `login` command that allows authentication and enables you to work with {product-title} projects, which map Kubernetes namespaces to authenticated users.
`20`	`19`	`ifndef::microshift[]`
	`20`	+The `oc` binary offers a built-in `login` command for authentication and lets you work with {product-title} projects, which map Kubernetes namespaces to authenticated users.
`21`	`21`	`See xref:../../authentication/understanding-authentication.adoc#understanding-authentication[Understanding authentication] for more information.`
`22`	`22`	`endif::[]`
`23`	`23`	`+`
	`24`	`+ifdef::microshift[]`
	`25`	+The `oc` binary offers a built-in `login` command for authentication to {product-title}.
	`26`	`+endif::[]`
	`27`	`++`
`24`	`28`	`* Additional commands`
`25`	`29`	`+`
`26`	`30`	The additional command `oc new-app`, for example, makes it easier to get new applications started using existing source code or pre-built images. Similarly, the additional command `oc new-project` makes it easier to start a project that you can switch to as your default.