Skip to content

TELCODOCS-2851: Fix AsciiDocDITA violations in SR-IOV device config#113896

Open
kquinn1204 wants to merge 1 commit into
openshift:enterprise-4.21from
kquinn1204:TELCODOCS-2851-4.21-CP
Open

TELCODOCS-2851: Fix AsciiDocDITA violations in SR-IOV device config#113896
kquinn1204 wants to merge 1 commit into
openshift:enterprise-4.21from
kquinn1204:TELCODOCS-2851-4.21-CP

Conversation

@kquinn1204

Copy link
Copy Markdown
Contributor

Summary

Backport of #109197 to enterprise-4.21.

  • Resolve all AsciiDocDITA Vale errors across configuring-sriov-device.adoc assembly and its included modules for DITA conversion readiness
  • Add [role="_abstract"] short descriptions to all modules and assembly
  • Convert unsupported callout lists to bullet lists / description lists
  • Fix AssemblyContents, BlockTitle, TaskStep, and TermsErrors violations

12 files included, 0 files excluded.

Verification

  • Preview renders correctly
  • No broken includes or cross-references
  • Content is appropriate for this release version

Backport of openshift#109197 to enterprise-4.21.

12 files included, 0 files excluded.

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 Jun 23, 2026
@openshift-ci-robot

openshift-ci-robot commented Jun 23, 2026

Copy link
Copy Markdown

@kquinn1204: This pull request references TELCODOCS-2851 which is a valid jira issue.

Details

In response to this:

Summary

Backport of #109197 to enterprise-4.21.

  • Resolve all AsciiDocDITA Vale errors across configuring-sriov-device.adoc assembly and its included modules for DITA conversion readiness
  • Add [role="_abstract"] short descriptions to all modules and assembly
  • Convert unsupported callout lists to bullet lists / description lists
  • Fix AssemblyContents, BlockTitle, TaskStep, and TermsErrors violations

12 files included, 0 files excluded.

Verification

  • Preview renders correctly
  • No broken includes or cross-references
  • Content is appropriate for this release version

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 Jun 23, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

`spec.nicSelector.deviceID`:: Optional: Specifies the device hexadecimal identifier of the SR-IOV network device. For example, `101b` is the device ID for a Mellanox ConnectX-6 device.
`spec.nicSelector.pfNames`:: Optional: Specifies an array of one or more physical function (PF) names the resource must apply to.
`spec.nicSelector.rootDevices`:: Optional: Specifies an array of one or more PCI bus addresses the resource must apply to. For example `0000:02:00.1`.
`spec.nicSelector.netFilter`:: Optional: Specifies the platform-specific network filter. The only supported platform is {rh-openstack-first}. Acceptable values use the following format: `openstack/NetworkID:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. Replace `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` with the value from the `/var/config/openstack/latest/network_data.json` metadata file. This filter ensures that VFs are associated with a specific OpenStack network. The operator uses this filter to map the VFs to the appropriate network based on metadata provided by the OpenStack platform.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] Vale.Terms: Use 'Operators?' instead of 'operator'.

@openshift-ci

openshift-ci Bot commented Jun 23, 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.

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.

4 participants