OSDOCS-16406: Cleaned up CLI References for DITA migration#113938
OSDOCS-16406: Cleaned up CLI References for DITA migration#113938EricPonvelle wants to merge 1 commit into
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@EricPonvelle: This pull request references OSDOCS-16406 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
Bot
added
the
size/L
| [id="rosa-download-ocp-client_{context}"] | ||
| == download oc | ||
|
|
||
| Download the latest compatible version of the OpenShift Container Platform CLI (`oc`). |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| |Enables debug mode. | ||
| |=== | ||
|
|
||
| .Examples |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.
| [id="rosa-verify-ocp-client_{context}"] | ||
| == verify oc | ||
|
|
||
| Verifies that the OpenShift Container Platform CLI (`oc`) is installed correctly. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| = Authenticate the {rosa-cli} with a single sign-on authorization code | ||
|
|
||
| [role="_abstract"] | ||
| The {rosa-cli} allows you to log into your account by using a Red{nbsp}Hat single sign-on authorization code. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'log in to' rather than 'log into'. For more information, see RedHat.TermsErrors.
|
|
||
| .Optional arguments inherited from parent commands | ||
| [cols="30,70"] | ||
| |=== |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskStep: Content other than a single list cannot be mapped to DITA steps.
|
|
||
| .Optional arguments inherited from parent commands | ||
| [cols="30,70"] | ||
| |=== |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskStep: Content other than a single list cannot be mapped to DITA steps.
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| The method of authenticating using Red{nbsp}Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the {cluster-manager-url-pull}. |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.
|
|
||
| .Optional arguments inherited from parent commands | ||
| [cols="30,70"] | ||
| |=== |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.TaskStep: Content other than a single list cannot be mapped to DITA steps.
| |Specifies an AWS profile (string) from your credentials file. | ||
| |=== | ||
|
|
||
| .Examples |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.
| |Specifies an AWS profile (string) from your credentials file. | ||
| |=== | ||
|
|
||
| .Examples |
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.
|
@EricPonvelle: 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. |
4 participants
Version(s):
enterprise-4.20+- to meet OCP's coverage of this book as wellIssue:
OSDOCS-16406
Link to docs preview:
QE review:
Additional information:
This PR updates the CLI references to ensure that DITA compliance is met.