Skip to content

TELCODOCS-2759: Add short description attributes for DITA compatibility#106768

Open
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:TELCODOCS-2759-dita-rewrite-ztp-deploying-far-edge-clusters-at-scale
Open

TELCODOCS-2759: Add short description attributes for DITA compatibility#106768
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:TELCODOCS-2759-dita-rewrite-ztp-deploying-far-edge-clusters-at-scale

Conversation

@kquinn1204
Copy link
Contributor

@kquinn1204 kquinn1204 commented Feb 17, 2026

Preview: https://106768--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-deploying-far-edge-clusters-at-scale.html

Summary

  • Added [role="_abstract"] to the first paragraph in 4 ZTP modules to support DITA <shortdesc> conversion
  • Resolves all AsciiDocDITA.ShortDescription Vale warnings for the ztp-deploying-far-edge-clusters-at-scale assembly

Files Modified

File Change
modules/about-ztp.adoc Added [role="_abstract"]
modules/ztp-challenges-of-far-edge-deployments.adoc Added [role="_abstract"]
modules/ztp-configuring-cluster-policies.adoc Added [role="_abstract"]
modules/ztp-creating-ztp-crs-for-multiple-managed-clusters.adoc Added [role="_abstract"]

Test plan

  • Vale AsciiDocDITA validation passes with 0 errors, 0 warnings
  • Verify AsciiDoc renders correctly
  • Run DITA conversion on modified files

🤖 Generated with Claude Code

Add [role="_abstract"] to the first paragraph of ZTP modules to support
DITA <shortdesc> conversion.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 17, 2026
@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 17, 2026

@kquinn1204: This pull request references TELCODOCS-2759 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 sub-task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Summary

  • Added [role="_abstract"] to the first paragraph in 4 ZTP modules to support DITA <shortdesc> conversion
  • Resolves all AsciiDocDITA.ShortDescription Vale warnings for the ztp-deploying-far-edge-clusters-at-scale assembly

Files Modified

File Change
modules/about-ztp.adoc Added [role="_abstract"]
modules/ztp-challenges-of-far-edge-deployments.adoc Added [role="_abstract"]
modules/ztp-configuring-cluster-policies.adoc Added [role="_abstract"]
modules/ztp-creating-ztp-crs-for-multiple-managed-clusters.adoc Added [role="_abstract"]

Test plan

  • Vale AsciiDocDITA validation passes with 0 errors, 0 warnings
  • Verify AsciiDoc renders correctly
  • Run DITA conversion on modified files

🤖 Generated with Claude Code

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 17, 2026
@ocpdocs-previewbot
Copy link

@openshift-ci
Copy link

openshift-ci bot commented Feb 17, 2026

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

@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 17, 2026

@kquinn1204: This pull request references TELCODOCS-2759 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 sub-task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Preview: https://106768--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-deploying-far-edge-clusters-at-scale.html

Summary

  • Added [role="_abstract"] to the first paragraph in 4 ZTP modules to support DITA <shortdesc> conversion
  • Resolves all AsciiDocDITA.ShortDescription Vale warnings for the ztp-deploying-far-edge-clusters-at-scale assembly

Files Modified

File Change
modules/about-ztp.adoc Added [role="_abstract"]
modules/ztp-challenges-of-far-edge-deployments.adoc Added [role="_abstract"]
modules/ztp-configuring-cluster-policies.adoc Added [role="_abstract"]
modules/ztp-creating-ztp-crs-for-multiple-managed-clusters.adoc Added [role="_abstract"]

Test plan

  • Vale AsciiDocDITA validation passes with 0 errors, 0 warnings
  • Verify AsciiDoc renders correctly
  • Run DITA conversion on modified files

🤖 Generated with Claude Code

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.

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. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants