OSDOCS-18265: Vale DITA fixes for OSD storage#109019
OSDOCS-18265: Vale DITA fixes for OSD storage#109019bhardesty wants to merge 1 commit intoopenshift:mainfrom
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@bhardesty: This pull request references OSDOCS-18265 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 task to target the "4.22.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/S
|
@bhardesty: 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. |
|
@bhardesty: This pull request references OSDOCS-18265 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 task to target the "4.22.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. |
| -- | ||
| where: | ||
|
|
||
| `Statement.Principal.Federated`:: Specify your AWS account ID and the OpenShift OIDC provider endpoint. |
There was a problem hiding this comment.
To knowledge, the best practice is to use the word "Specifies" rather than an infinitive "Specify". At least "specifies" is used in the Example use cases in the Callout replacement for OCP docs doc.
There was a problem hiding this comment.
Agreed - let's switch it to "Specifies"
| role_arn = <role_ARN> | ||
| web_identity_token_file = /var/run/secrets/openshift/serviceaccount/token | ||
| ---- | ||
| <1> Replace `role_ARN` with the output you saved while creating the role. |
There was a problem hiding this comment.
Just to confirm that this callout can be deleted entirely and doesn't need to be replaced?
There was a problem hiding this comment.
I think it's pretty self-evident for users so, I am cool with dropping this explanation.
|
@bhardesty The preview is looking good. Left a couple of questions. Do I get it correctly that other CQA fixes are out of scope of this PR? E.g. a short description uses self-referential language (This procedure explains how to...) or a prereqs list doesn't need periods at the end of items that are incomplete sentences (in a module one item has a period). |
| -- | ||
| where: | ||
|
|
||
| `Statement.Principal.Federated`:: Specify your AWS account ID and the OpenShift OIDC provider endpoint. |
There was a problem hiding this comment.
Agreed - let's switch it to "Specifies"
| role_arn = <role_ARN> | ||
| web_identity_token_file = /var/run/secrets/openshift/serviceaccount/token | ||
| ---- | ||
| <1> Replace `role_ARN` with the output you saved while creating the role. |
There was a problem hiding this comment.
I think it's pretty self-evident for users so, I am cool with dropping this explanation.
5 participants
This PR addresses the Vale DITA fixes for the OSD content in the Storage book. It does not address any Vale issues for non-OSD content.
Version(s):
Issue:
https://redhat.atlassian.net/browse/OSDOCS-18265
Link to docs preview:
QE review: