Skip to content

TELCODOCS-2857: Fix DITA conversion issues in SR-IOV net attach docs#109222

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

TELCODOCS-2857: Fix DITA conversion issues in SR-IOV net attach docs#109222
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:TELCODOCS-2857

Conversation

@kquinn1204
Copy link
Copy Markdown
Contributor

Summary

  • Fix all Vale AsciiDocDITA Error and Warning violations in configuring-sriov-net-attach.adoc assembly and its 12 included modules
  • Add missing [role="_abstract"] short descriptions to 3 modules (nw-sriov-network-object, cnf-assigning-a-sriov-network-to-a-vrf, nw-sriov-configure-exclude-topology-manager)
  • Convert 4 callout lists to bullet lists in open blocks (callouts are unsupported in DITA)
  • Replace 3 unsupported .Example output block titles with lead-in text
  • Fix typo ("comand" → "command"), spelling warnings ("VRFs" → "VRF instances", netmask backticked), hyphenation ("multi-tenant" → "multitenant"), and hard-wrapped lines

Test plan

  • Verify Vale reports no Error or Warning violations on modified files
  • Confirm AsciiDoc renders correctly with asciibinder build
  • Review bullet list formatting in nw-sriov-network-object.adoc and nw-sriov-configure-exclude-topology-manager.adoc for correct open block structure

🤖 Generated with Claude Code

Resolve all Vale AsciiDocDITA Error and Warning violations across
the SR-IOV Ethernet network attachment assembly and its included
modules: add missing short descriptions, convert callout lists to
bullet lists, replace unsupported block titles, fix spelling and
hard-wrapped lines.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci-robot
Copy link
Copy Markdown

openshift-ci-robot commented Mar 30, 2026

@kquinn1204: This pull request references TELCODOCS-2857 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 Vale AsciiDocDITA Error and Warning violations in configuring-sriov-net-attach.adoc assembly and its 12 included modules
  • Add missing [role="_abstract"] short descriptions to 3 modules (nw-sriov-network-object, cnf-assigning-a-sriov-network-to-a-vrf, nw-sriov-configure-exclude-topology-manager)
  • Convert 4 callout lists to bullet lists in open blocks (callouts are unsupported in DITA)
  • Replace 3 unsupported .Example output block titles with lead-in text
  • Fix typo ("comand" → "command"), spelling warnings ("VRFs" → "VRF instances", netmask backticked), hyphenation ("multi-tenant" → "multitenant"), and hard-wrapped lines

Test plan

  • Verify Vale reports no Error or Warning violations on modified files
  • Confirm AsciiDoc renders correctly with asciibinder build
  • Review bullet list formatting in nw-sriov-network-object.adoc and nw-sriov-configure-exclude-topology-manager.adoc for correct open block structure

🤖 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-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 openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 30, 2026
@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