OSDOCS-17013-bm-upi: CQA2.0 complete for BM UPI doc #103618
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openshift-ci
bot
added
the
size/XS
dfitzmau
force-pushed
the
OSDOCS-17013-bm-upi
branch
from
e2962e9 to
ba14d03
Compare
openshift-ci
bot
added
size/M
dfitzmau
force-pushed
the
OSDOCS-17013-bm-upi
branch
from
ba14d03 to
3c5ceb0
Compare
|
🤖 Tue Dec 09 12:54:56 - Prow CI generated the docs preview: |
installing/installing_bare_metal/upi/installing-bare-metal.adoc
Outdated
Show resolved
Hide resolved
dfitzmau
force-pushed
the
OSDOCS-17013-bm-upi
branch
2 times, most recently
from
11cb533 to
ee42caa
Compare
openshift-ci
bot
added
size/XL
| . Select the appropriate version from the *Version* drop-down list. | ||
| . Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. | ||
| endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] | ||
| . Unpack and unzip the archive. |
Collaborator
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'extract' or 'decompress' rather than 'unzip'. For more information, see RedHat.TermsErrors.
| . Select the appropriate version from the *Version* list. | ||
| . Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. | ||
| endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] | ||
| . Unzip the archive with a ZIP program. |
Collaborator
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'extract' or 'decompress' rather than 'Unzip'. For more information, see RedHat.TermsErrors.
dfitzmau
force-pushed
the
OSDOCS-17013-bm-upi
branch
from
ee42caa to
a3c620d
Compare
dfitzmau
force-pushed
the
OSDOCS-17013-bm-upi
branch
from
a3c620d to
71013d5
Compare
|
@dfitzmau: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
dfitzmau
added
the
merge-review-needed
jeana-redhat
added
the
merge-review-in-progress
Contributor
jeana-redhat
left a comment
jeana-redhat
left a comment
There was a problem hiding this comment.
Really nice work, this is in significantly better shape for migration. Additional gold star for cleaning up additional resources content, thank you! A couple little things i saw in here, but not much given the scope of the changes 🤓
/remove-label merge-review-in-progress
/remove-label merge-review-needed
|
|
||
| You can install the {oc-first} to interact with {product-title} from a command-line interface. You can install `oc` on Linux, Windows, or macOS. | ||
| [role="_abstract"] | ||
| You can install the {oc-first} binary on Linux by using the following procedure. |
Contributor
There was a problem hiding this comment.
I know this was existing text but might as well nix the self-referential part while you're in here :)
Suggested change
| You can install the {oc-first} binary on Linux by using the following procedure. | |
| You can install the {oc-first} binary on Linux. |
| = Installing the OpenShift CLI on macOS | ||
|
|
||
| [role="_abstract"] | ||
| You can install the {oc-first} binary on macOS by using the following procedure. |
Contributor
There was a problem hiding this comment.
Suggested change
| You can install the {oc-first} binary on macOS by using the following procedure. | |
| You can install the {oc-first} binary on macOS. |
| = Installing the OpenShift CLI on Windows | ||
|
|
||
| [role="_abstract"] | ||
| You can install the {oc-first} binary on Windows by using the following procedure. |
Contributor
There was a problem hiding this comment.
Suggested change
| You can install the {oc-first} binary on Windows by using the following procedure. | |
| You can install the {oc-first} binary on Windows. |
Contributor
There was a problem hiding this comment.
There are a couple discrepancies between the Linux, Mac, and Windows steps:
- Linux has a step (2. Select the architecture from the Product Variant list.) that is missing from the others. Seems the user needs to pick that regardless of what OS they are going to run
ocfrom. - The Mac version of "Select the appropriate version from the Version drop-down list." says "drop-down list" instead of just "list" like the other two.
- The Mac version has PATH without backticks in one place where the other two always use
PATH. I marked both the Mac discrepancies in the module for easy reference.
I assume these result from duplicated content that has become skewed over time. A snippet of common steps might be helpful to make sure things don't become inaccurate or inconsistent across slightly different procedures. I don't know if you want to do that or not while you are here, but either way should probably make sure they are all right and match where appropriate.
Contributor
Author
There was a problem hiding this comment.
I'll make these changes but the original content is really outside of scope so I'll make low-level changes. I'm only assisting the install team with this work.
| endif::[] | ||
| ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] | ||
| . Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. | ||
| . Select the appropriate version from the *Version* drop-down list. |
Contributor
There was a problem hiding this comment.
Suggested change
| . Select the appropriate version from the *Version* drop-down list. | |
| . Select the appropriate version from the *Version* list. |
| . Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. | ||
| endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] | ||
| . Unpack and unzip the archive. | ||
| . Move the `oc` binary to a directory on your PATH. |
Contributor
There was a problem hiding this comment.
Suggested change
| . Move the `oc` binary to a directory on your PATH. | |
| . Move the `oc` binary to a directory on your `PATH`. |
Comment on lines
+18
to
+24
| include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] | ||
|
|
||
| // Installing the OpenShift CLI on Windows | ||
| include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] | ||
|
|
||
| // Installing the OpenShift CLI on macOS | ||
| include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] |
Contributor
There was a problem hiding this comment.
Looks like these should be [leveloffset=+2] like the module they replaced
openshift-ci
bot
removed
merge-review-in-progress
Contributor
Author
|
/cherrypick enterprise-4.21 |
Contributor
Author
|
/cherrypick enterprise-4.20 |
Contributor
Author
|
/cherrypick enterprise-4.19 |
Contributor
Author
|
/cherrypick enterprise-4.18 |
Contributor
Author
|
/cherrypick enterprise-4.17 |
Contributor
Author
|
/cherrypick enterprise-4.16 |
|
@dfitzmau: new pull request created: #103857 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@dfitzmau: new pull request created: #103858 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@dfitzmau: new pull request created: #103859 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@dfitzmau: #103618 failed to apply on top of branch "enterprise-4.18": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@dfitzmau: #103618 failed to apply on top of branch "enterprise-4.17": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@dfitzmau: #103618 failed to apply on top of branch "enterprise-4.16": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continue from include::modules/installation-user-infra-machines-pxe.adoc
Version(s):
4.16+
Issue:
OSDOCS-17013
Link to docs preview: