OSDOCS-16919: Add content type attributes and fix Vale warnings in we… - #115956
OSDOCS-16919: Add content type attributes and fix Vale warnings in we…#115956jseseCCS wants to merge 1 commit into
Conversation
|
@jseseCCS: This pull request references OSDOCS-16919 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. |
|
@jhadvig or @rhamilto I removed the access-cluster-configuration-console.adoc snippet and inlined its steps into 3 modules; restructured callout lists in contributing-quick-starts.adoc and understanding-quick-start-elements.adoc for DITA compatibility. could use a QE/SME sanity check on these before merge. 🙏 ? |
|
🤖 Tue Jul 28 16:50:05 - Prow CI generated the docs preview: |
|
/lgtm |
|
dear merge reviewer: I've completed technical remediation: All 20 assemblies/modules in this PR pass Vale with 0 errors/warnings, and I've added content-type attributes throughout. @rhamilto completed a SME review; I resolved his question about the inlined steps in the web terminal admin modules (the fix was intentional. the shared snippet was splicing into an ordered list mid-procedure without its own title, which broke DITA modularity). I've filled out the CQA 2.1 spreadsheet and attached it to the Jira Story. This is ready for merge-review. |
|
/label merge-review-needed |
maxwelldb
left a comment
There was a problem hiding this comment.
Could you verify that all files included here are correct? accept.txt looks like something that should not be committed to the shared repo.
8e9c83d to
6cad4eb
Compare
|
New changes are detected. LGTM label has been removed. |
|
@maxwelldb removed! how's it look? |
|
/label merge-review-needed |
|
@openshift/team-documentation Max is on PTO and suggested I make sure to request that someone else help finish this merge review in his stead. TIA |
…b_console Adds content type attributes across web_console modules, splits the console/download route content out of customizing-the-web-console-URL.adoc into new dedicated modules, and removes the unused access-cluster-configuration-console.adoc snippet. Also cleans up wrapped table cells and wording in dynamic-plugin-api.adoc and dynamic-plugin-sdk-extensions.adoc, restructures the DITA-invalid callout lists in contributing-quick-starts.adoc and understanding-quick-start-elements.adoc, and adds a new term to the Vale vocabulary. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
6cad4eb to
a6f74cc
Compare
|
@jseseCCS: 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. |
|
Hey @jseseCCS I am going to remove this PR from the merge review queue for a few reasons: This PR is too large for any reviewer to reasonably review without risking us missing critical issues. Our guidance is to keep CQA PRs a size L or smaller (the exception being that you can have an XL PR if it addresses a single, straightforward change, such as a PR that fixes only abstracts or only links). In addition, the PR has merge conflicts that need resolution. Please break this PR up into several smaller PRs, ideally at least 3, but the more the merrier. Please reach out to me if you have any questions, thanks! |
|
PR needs rebase. 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. |
|
per your excellent comments, closing this in favor of 6 smaller PRs, split out per your request to keep CQA PRs at size L or smaller. Each is single-purpose and Vale-clean, and all CI checks are passing:
|
|
PR needs rebase. 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. |
|
see my previous comment |
…b_console
Adds content type attributes across web_console modules, splits the console/download route content out of customizing-the-web-console-URL.adoc into new dedicated modules, and removes the unused access-cluster-configuration-console.adoc snippet. Also cleans up wrapped table cells and wording in dynamic-plugin-api.adoc and dynamic-plugin-sdk-extensions.adoc, restructures the DITA-invalid callout lists in contributing-quick-starts.adoc and understanding-quick-start-elements.adoc, and adds a new term to the Vale vocabulary.
Version(s): OCP CQA
Issue: https://redhat.atlassian.net/browse/OSDOCS-16919
Link to docs preview:
QE review:
Additional information: