Skip to content

TELCODOCS-2844: Fix AsciiDocDITA violations in SR-IOV sysctl docs#109186

Open
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:TELCODOCS-2844
Open

TELCODOCS-2844: Fix AsciiDocDITA violations in SR-IOV sysctl docs#109186
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:TELCODOCS-2844

Conversation

@kquinn1204
Copy link
Copy Markdown
Contributor

Summary

  • Fix all AsciiDocDITA Vale errors across the SR-IOV sysctl assembly (configuring-interface-sysctl-sriov-device.adoc) and its 9 included modules for DITA conversion compatibility
  • Add [role="_abstract"] short descriptions to all 10 files
  • Convert 11 callout lists to DITA-compatible bulleted lists in open blocks
  • Fix unsupported block titles (.Verifying..., .Verification of..., .Example output) to supported DITA task titles or lead-in sentences
  • Merge duplicate .Verification sections into single sections
  • Add missing .Procedure block title in nw-label-nodes-with-sriov.adoc
  • Change nw-sriov-interface-level-sysctl-bonded-node-policy.adoc content type from CONCEPT to PROCEDURE
  • Fix terminology: "bare metal nodes" → "bare-metal nodes", "Datapath" → "Data Path"

Test plan

  • Verify all files pass Vale AsciiDocDITA rules with no errors
  • Verify AsciiDoc renders correctly with asciibinder build
  • Review callout-to-bullet-list conversions for accuracy

🤖 Generated with Claude Code

… and modules

Resolve all AsciiDocDITA Vale errors across 10 files for DITA conversion
compatibility: add short descriptions, convert callout lists to bullet
lists, fix unsupported block titles, merge duplicate verification sections,
add missing .Procedure titles, correct content type, and fix terminology.

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 Mar 30, 2026
@openshift-ci-robot
Copy link
Copy Markdown

openshift-ci-robot commented Mar 30, 2026

@kquinn1204: This pull request references TELCODOCS-2844 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

  • Fix all AsciiDocDITA Vale errors across the SR-IOV sysctl assembly (configuring-interface-sysctl-sriov-device.adoc) and its 9 included modules for DITA conversion compatibility
  • Add [role="_abstract"] short descriptions to all 10 files
  • Convert 11 callout lists to DITA-compatible bulleted lists in open blocks
  • Fix unsupported block titles (.Verifying..., .Verification of..., .Example output) to supported DITA task titles or lead-in sentences
  • Merge duplicate .Verification sections into single sections
  • Add missing .Procedure block title in nw-label-nodes-with-sriov.adoc
  • Change nw-sriov-interface-level-sysctl-bonded-node-policy.adoc content type from CONCEPT to PROCEDURE
  • Fix terminology: "bare metal nodes" → "bare-metal nodes", "Datapath" → "Data Path"

Test plan

  • Verify all files pass Vale AsciiDocDITA rules with no errors
  • Verify AsciiDoc renders correctly with asciibinder build
  • Review callout-to-bullet-list conversions for accuracy

🤖 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/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 30, 2026
@ocpdocs-previewbot
Copy link
Copy Markdown

@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Mar 30, 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.

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/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants