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: 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. |
| 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.
There was a problem hiding this comment.
As I've been fixing callouts, I've just been deleting any that are self-explanatory.
However, in this case, this callout was in a commented-out section of text. Vale still flags it even though it's commented-out. So I just deleted the callout entirely so Vale would stop complaining.
|
@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). |
| 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.
bhardesty
force-pushed
the
osdocs-18265-vale-fixes-osd-storage
branch
from
04dd204 to
ffa36a9
Compare
|
New changes are detected. LGTM label has been removed. |
Yes, this is just to address the Vale warnings/errors in the content that HCM Docs "owns" in the Storage book (which in this case amounts to a single module). The CQA will be a separate jira and PR, and should be handled by an OCP writer. |
|
@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. |
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: