Skip to content

OSDOCS-16919: Add content type attributes and fix Vale warnings in we… - #115956

Open
jseseCCS wants to merge 1 commit into
openshift:mainfrom
jseseCCS:OSDOCS-16919-clean
Open

OSDOCS-16919: Add content type attributes and fix Vale warnings in we…#115956
jseseCCS wants to merge 1 commit into
openshift:mainfrom
jseseCCS:OSDOCS-16919-clean

Conversation

@jseseCCS

Copy link
Copy Markdown
Contributor

…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:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 21, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 21, 2026

Copy link
Copy Markdown

@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.

Details

In response to this:

…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:

  • QE has approved this change.

Additional information:

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 openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 21, 2026
@jseseCCS

jseseCCS commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

@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. 🙏 ?

@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 21, 2026

Copy link
Copy Markdown

🤖 Mon Jul 27 16:56:56 - Prow CI generated the docs preview:
https://115956--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@rhamilto

Copy link
Copy Markdown
Member

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 21, 2026
@jseseCCS

Copy link
Copy Markdown
Contributor Author

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.

@jseseCCS

Copy link
Copy Markdown
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci Bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 21, 2026
@maxwelldb maxwelldb added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jul 24, 2026

@maxwelldb maxwelldb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you verify that all files included here are correct? accept.txt looks like something that should not be committed to the shared repo.

@maxwelldb maxwelldb removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 24, 2026
@maxwelldb maxwelldb added this to the Continuous Release milestone Jul 24, 2026
…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>
@jseseCCS
jseseCCS force-pushed the OSDOCS-16919-clean branch from 8e9c83d to 6cad4eb Compare July 27, 2026 16:50
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 27, 2026
@openshift-ci

openshift-ci Bot commented Jul 27, 2026

Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@jseseCCS

Copy link
Copy Markdown
Contributor Author

@maxwelldb removed! how's it look?

@openshift-ci

openshift-ci Bot commented Jul 27, 2026

Copy link
Copy Markdown

@jseseCCS: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

@jseseCCS

Copy link
Copy Markdown
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci Bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. merge-review-needed Signifies that the merge review team needs to review this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants