Updated KMM Operator modules to pass DITA validation #96020
Conversation
openshift-ci
bot
added
the
size/L
| You can install KMM on the spokes cluster through a RHACM `Policy` object. In addition to installing KMM from the OperatorHub and running it in a lightweight spoke mode, the `Policy` configures additional RBAC required for the RHACM agent to be able to manage `Module` resources. | ||
|
|
||
| .Procedure | ||
|
|
||
| * Use the following RHACM policy to install KMM on spoke clusters: |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.
modules/kmm-running-depmod.adoc
Outdated
| == Example Dockerfile | ||
|
|
||
| .Example Dockerfile | ||
| ==== | ||
| If you are building your image on {product-title}, consider using the Driver Tool Kit (DTK). |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'toolkit' rather than 'Tool Kit'. For more information, see RedHat.TermsErrors.
There was a problem hiding this comment.
Correct term is "Driver Toolkit (DTK)"
There was a problem hiding this comment.
Thank you. Not a line I initially touched, but fixed.
| @@ -24,8 +24,8 @@ $ depmod -b /opt ${KERNEL_FULL_VERSION}+`. | |||
| ---- | |||
There was a problem hiding this comment.
The code on the previous line looks off to me, I checked the revision history and the characters at the end look like a fragment from when it was formatted as inline code. I believe it should be as follows:
$ depmod -b /opt ${KERNEL_FULL_VERSION}Can somebody confirm this? If so, I can fix it as part of this PR.
There was a problem hiding this comment.
It should be $ depmod -b /opt ${KERNEL_FULL_VERSION}+.
There was a problem hiding this comment.
Hi @StephenJamesSmith, that doesn't sound right, if you are passing depmod a specific version, according to the manual page the + symbol has no special meaning and will just register as an invalid kernel version. I checked the older documentation prior to moving this command from inline code to a dedicated code block and it confirms my understanding. Could you please look one more time?
|
LGTM |
|
@jhradilek: all tests passed! Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
Version(s): 4.19
Issue: N/A
Link to docs preview:
QE review:
Additional information:
This pull request addresses all issues reported by the AsciiDocDITA vale style as well as additional errors discovered during test conversion.