Skip to content

Commit f7fa0ea

Browse files
committed
OSDOCS-4752 Pre-GA docs nit corrections
1 parent 7f3db16 commit f7fa0ea

22 files changed

+299
-291
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ Topics:
8989
File: getting-started-cli
9090
- Name: Configuring the OpenShift CLI
9191
File: configuring-cli
92-
- Name: Managing CLI profiles
93-
File: managing-cli-profiles
92+
# - Name: Managing CLI profiles
93+
# File: managing-cli-profiles
9494
- Name: Extending the OpenShift CLI with plug-ins
9595
File: extending-cli-plugins
9696
# FIXME: auto-generated content in the next file includes commands

cli_reference/index.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ These tools expose simple commands to manage the applications, as well as intera
2424

2525
The following set of CLI tools are available in {product-title}:
2626

27-
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (oc)]: This is the most commonly used CLI tool by {product-title} users. It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.
27+
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (oc)]: This is the most commonly used CLI tool by {product-title} users. It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal.
28+
ifndef::microshift[]
29+
Unlike the web console, it allows the user to work directly with the project source code using command scripts.
30+
endif::microshift[]
2831

2932
ifndef::microshift[]
3033
* xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The Knative (`kn`) CLI tool provides simple and intuitive terminal commands that can be used to interact with OpenShift Serverless components, such as Knative Serving and Eventing.

microshift_getting_started/microshift-architecture.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Learn the specifics of {product-title} architecture including design intent, how
1616
* Devices with {product-title} installed are self-managing
1717
* Compatible with rpm-ostree-based systems
1818
* Uses only the APIs needed for essential functions, such as security and runtime controls
19-
* Reuses select commands from the OpenShift CLI (`oc`) tool
19+
* Enables a subset of commands from the OpenShift CLI (`oc`) tool
2020

2121
// * You can use in locations where full control is needed
2222
// * Works offline and in low-connectivity environments

microshift_getting_started/microshift-understanding.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

9-
Get an overview of what you can do with {product-title}, a distribution of {OCP} designed for optimizing small form factors and edge computing.
9+
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.
1010

1111
include::modules/about-microshift.adoc[leveloffset=+1]
1212

microshift_install/microshift-install-rhel-for-edge.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-install-rhel-for-edge
66
toc::[]
77

8-
You can embed MicroShift into a {op-system-ostree-first} {op-system-version} image.
8+
You can embed {product-title} into a {op-system-ostree-first} {op-system-version} image.
99

10-
== Embedding MicroShift into a {op-system-ostree} image
10+
= Embedding {product-title} into a {op-system-ostree} image
1111

12-
Use the content within this section to build a {op-system-ostree-first} {op-system-version} image containing MicroShift.
12+
Use the content within this section to build a {op-system-ostree-first} {op-system-version} image containing {product-title}.
1313

1414
[NOTE]
1515
====
16-
{op-system} 9.0 is currently unsupported for MicroShift deployments.
16+
{op-system} 9.0 is currently unsupported for {product-title} deployments.
1717
====
1818

1919
//include modules/prerequisites-for-installing-microshift.adoc
Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,49 @@
11
:_content-type: ASSEMBLY
22
[id="microshift-install-rpm"]
3-
= Installing MicroShift from an RPM package
3+
= Installing {product-title} from an RPM package
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-install-rpm
66
toc::[]
77

8-
You can install {product-title} from an RPM package on a machine with {op-system-first} {op-system-version}.
8+
You can install {product-title} from an RPM package on a machine with {op-system-first} {op-system-version}.
99

1010
[IMPORTANT]
1111
====
1212
Red Hat will not provide or support an update or upgrade path from Developer Preview and Technology Preview versions to later versions of {product-title}. A new installation will be necessary.
1313
====
1414

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

17-
include::modules/preparing-for-installing-microshift-rpm.adoc[leveloffset=+1]
17+
include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
1818

19-
include::modules/installing-microshift-rpm.adoc[leveloffset=+1]
19+
[role="_additional-resources"]
20+
.Additional resources
2021

21-
include::modules/starting-microshift-service.adoc[leveloffset=+1]
22+
* xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[System Requirements for Installing MicroShift] have been met.
2223
23-
include::modules/stopping-microshift-service.adoc[leveloffset=+1]
24+
* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console.
2425
25-
include::modules/accessing-microshift.adoc[leveloffset=+1]
26+
* xref:../microshift_configuring/microshift-using-config-tools.adoc#microshift-using-config-tools[Configuring MicroShift].
2627
27-
include::modules/accessing-microshift-cluster-locally.adoc[leveloffset=+2]
28+
* 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].
2829
29-
include::modules/accessing-microshift-cluster-remotely.adoc[leveloffset=+2]
30+
* 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]
31+
32+
include::modules/microshift-installing-from-rpm.adoc[leveloffset=+1]
33+
34+
[role="_additional-resources"]
35+
.Additional resources
36+
37+
* xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[system requirements for installing MicroShift] have been met.
38+
39+
* xref:../microshift_install/microshift-install-rpm.adoc#preparing-install-microshift-from-rpm-package_microshift-install-rpm[Preparing to install MicroShift from an RPM package].
40+
41+
include::modules/microshift-service-starting.adoc[leveloffset=+1]
42+
43+
include::modules/microshift-service-stopping.adoc[leveloffset=+1]
44+
45+
include::modules/microshift-accessing.adoc[leveloffset=+1]
46+
47+
include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
48+
49+
include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]

modules/about-microshift.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="con-about-microshift_{context}"]
66
= About {product-title}
77

8-
Working with low-resource field environments and hardware presents many challenges not experienced with cloud computing. {product-title} enables you to solve problems for edge devices by:
8+
Working with resource-constrained field environments and hardware presents many challenges not experienced with cloud computing. {product-title} enables you to solve problems for edge devices by:
99

1010
* Overcoming the operational challenge of minimal system resources, for example, a {op-system-chip}.
1111
* Addressing the environmental challenges of severe networking constraints such as low or no connectivity.

modules/accessing-microshift-cluster-locally.adoc

Lines changed: 0 additions & 36 deletions
This file was deleted.

modules/accessing-microshift-cluster-remotely.adoc

Lines changed: 0 additions & 69 deletions
This file was deleted.

modules/accessing-microshift.adoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)