OSDOCS -17445 [ROSA] CQA Improvements on Assemblies #109160
OSDOCS -17445 [ROSA] CQA Improvements on Assemblies #109160jc-berger wants to merge 2 commits intoopenshift:mainfrom
Conversation
openshift-ci
bot
added
the
size/M
| [role="_additional-resources"] | ||
| [id="additional-resources_operator-roles_{context}"] | ||
| .Additional resources | ||
| * link:https://docs.aws.amazon.com/rosa/latest/userguide/security-iam-awsmanpol.html[AWS documentation for Managed IAM policies for {product-title} clusters] No newline at end of file |
There was a problem hiding this comment.
Reviewers:
Within the assembly, we constantly had this link included as an "additional resources" for each procedure/level 2 heading.
I don't think we need to be this redundant. However, since it's technically part of several different procedures, maybe it does need to be kept.
Thoughts?
There was a problem hiding this comment.
We could probably take the duplicated links out of the modules and put them in a general Additional Resources in the holding Assembly.
| [id="additional-resources_role-overview_{context}"] | ||
| .Additional resources | ||
| * link:https://docs.aws.amazon.com/rosa/latest/userguide/security-iam-awsmanpol.html[AWS Managed IAM policies for {product-title} clusters] | ||
| include::modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+1] |
There was a problem hiding this comment.
Reviewers:
In the original assembly, all the level 2 headers included a procedure. So instead of making new modules, I simply added to the abstract/short description of the existing modules, and added an additional resources section since the assembly had one of those for each level 2.
Do you all like this approach instead of me making new modules for all these level 2 headers in the original assembly?
|
🤖 Fri Mar 27 18:16:56 - Prow CI generated the docs preview: |
|
@jc-berger: The following test failed, say
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. |
EricPonvelle
left a comment
EricPonvelle
left a comment
There was a problem hiding this comment.
Small comment, but looks good to me otherwise.
| [role="_additional-resources"] | ||
| [id="additional-resources_operator-roles_{context}"] | ||
| .Additional resources | ||
| * link:https://docs.aws.amazon.com/rosa/latest/userguide/security-iam-awsmanpol.html[AWS documentation for Managed IAM policies for {product-title} clusters] No newline at end of file |
There was a problem hiding this comment.
We could probably take the duplicated links out of the modules and put them in a general Additional Resources in the holding Assembly.
3 participants
Version(s):
4.20+
Issue:
https://redhat.atlassian.net/browse/OSDOCS-17445
Link to docs preview:
QE review:
Additional information: