Skip to content

TELCODOCS-2853: Fix AsciiDocDITA violations for hardware offloading docs#109200

Merged
slovern merged 1 commit into
openshift:mainfrom
kquinn1204:TELCODOCS-2853
Jul 10, 2026
Merged

TELCODOCS-2853: Fix AsciiDocDITA violations for hardware offloading docs#109200
slovern merged 1 commit into
openshift:mainfrom
kquinn1204:TELCODOCS-2853

Conversation

@kquinn1204

@kquinn1204 kquinn1204 commented Mar 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add [role="_abstract"] short descriptions to all 10 files (assembly + 9 modules)
  • Replace all callout lists with DITA-compatible bullet lists using user-replaceable <value> placeholders (8 instances across 5 modules)
  • Extract inline Prerequisites section from assembly into new nw-sriov-hwol-prerequisites.adoc module with adjusted xref paths
  • Change nw-sriov-hwol-ref-openstack-sriov-policy.adoc content type from PROCEDURE to REFERENCE and convert unsupported block title to normal text
  • Convert .Example output block title to lead-in sentence in nw-sriov-hwol-configuring-machine-config-pool.adoc
  • Fix terminology: "bare metal" → "bare-metal", "network interface card" → "network interface controller (NIC)", "like" → "such as"

Test plan

  • Verify Vale AsciiDocDITA rules pass with no errors or warnings (except legitimate spelling: vSwitch, Dx)
  • Verify asciibinder build completes without errors
  • Review rendered output for the hardware offloading assembly
  • Confirm xref paths in the new prerequisites module resolve correctly

🤖 Generated with Claude Code

@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

openshift-ci-robot commented Mar 30, 2026 •
edited by openshift-ci Bot
Loading

Copy link
Copy Markdown

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

  • Add [role="_abstract"] short descriptions to all 10 files (assembly + 9 modules)
  • Replace all callout lists with DITA-compatible bullet lists using user-replaceable <value> placeholders (8 instances across 5 modules)
  • Extract inline Prerequisites section from assembly into new nw-sriov-hwol-prerequisites.adoc module with adjusted xref paths
  • Change nw-sriov-hwol-ref-openstack-sriov-policy.adoc content type from PROCEDURE to REFERENCE and convert unsupported block title to normal text
  • Convert .Example output block title to lead-in sentence in nw-sriov-hwol-configuring-machine-config-pool.adoc
  • Fix terminology: "bare metal" → "bare-metal", "network interface card" → "network interface controller (NIC)", "like" → "such as"

Test plan

  • Verify Vale AsciiDocDITA rules pass with no errors or warnings (except legitimate spelling: vSwitch, Dx)
  • Verify asciibinder build completes without errors
  • Review rendered output for the hardware offloading assembly
  • Confirm xref paths in the new prerequisites module resolve correctly

🤖 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

ocpdocs-previewbot commented Mar 30, 2026 •
edited
Loading

Copy link
Copy Markdown

🤖 Fri Jun 26 13:11:31 - Prow CI generated the docs preview:

https://109200--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/hardware_networks/configuring-hardware-offloading.html

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Mar 30, 2026
View reviewed changes
Comment thread modules/nw-sriov-hwol-prerequisites.adoc Outdated
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Mar 30, 2026
View reviewed changes
Comment thread modules/nw-sriov-hwol-prerequisites.adoc Outdated
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Mar 30, 2026
View reviewed changes
Comment thread modules/nw-sriov-hwol-prerequisites.adoc Outdated
@kquinn1204 @claude
TELCODOCS-2853: Fix AsciiDocDITA violations for hardware offloading docs
856f6d5 
Resolve all Vale AsciiDocDITA errors and warnings to prepare the
configuring-hardware-offloading assembly and its modules for DITA
conversion. Changes include adding short descriptions, replacing
callouts with bullet lists, extracting inline prerequisites to a
new module, fixing terminology, and correcting content type.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

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

openshift-ci Bot commented Jun 26, 2026

Copy link
Copy Markdown

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

@slovern slovern added this to the Continuous Release milestone Jul 10, 2026
@slovern slovern merged commit 56fa871 into openshift:main Jul 10, 2026
2 checks passed
@slovern

slovern commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

/cherrypick enterprise-5.0

@slovern

slovern commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

/cherrypick enterprise-4.22

@slovern

slovern commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

/cherrypick enterprise-4.21

@slovern

slovern commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

/cherrypick enterprise-4.20

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Jul 10, 2026

Copy link
Copy Markdown

@slovern: new pull request created: #115060

Details

In response to this:

/cherrypick enterprise-5.0

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.

This was referenced Jul 10, 2026
Merged
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Jul 10, 2026

Copy link
Copy Markdown

@slovern: new pull request created: #115061

Details

In response to this:

/cherrypick enterprise-4.22

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.

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Jul 10, 2026

Copy link
Copy Markdown

@slovern: new pull request created: #115062

Details

In response to this:

/cherrypick enterprise-4.21

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jul 10, 2026
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Jul 10, 2026

Copy link
Copy Markdown

@slovern: new pull request created: #115063

Details

In response to this:

/cherrypick enterprise-4.20

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jul 10, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 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

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

6 participants

@kquinn1204 @openshift-ci-robot @ocpdocs-previewbot @slovern @openshift-cherrypick-robot @ocpdocs-vale-bot