TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly by kquinn1204 · Pull Request #106280 · openshift/openshift-docs

kquinn1204 · 2026-02-10T13:53:21Z

[TELCODOCS-2647]: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly

Version(s): 4.20+

Issue: https://issues.redhat.com/browse/TELCODOCS-2647

Link to docs preview: https://106280--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/advanced_networking/ptp/configuring-ptp.html

QE review:

QE has approved this change.

Additional information: Resolve all AsciiDocDITA errors across 28 files in the configuring-ptp assembly to prepare for DITA conversion:

Add [role="_abstract"] short descriptions to 27 modules
Transform callout lists to definition/bulleted lists in 9 modules
Convert example block delimiters (====) to open blocks (--) for NOTE/IMPORTANT admonitions and remove [%collapsible] wrappers
Fix misspelled .Prerequisties block title in nw-ptp-device-discovery
Connect loose paragraphs to procedure steps with + continuations
Remove descriptive text from Additional resources link in assembly

Note: These are editorial/DITA-prep changes only - no technical content changes. A separate 4.16-specific PR will be created for the DITA conversion backport targeting only the modules that exist in 4.16.

ocpdocs-previewbot · 2026-02-10T15:25:35Z

🤖 Fri Mar 13 13:03:31 - Prow CI generated the docs preview:

https://106280--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/advanced_networking/ptp/configuring-ptp.html

openshift-ci-robot · 2026-02-17T11:11:12Z

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

Details

In response to this:

[TELCODOCS-2647]: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly

Version(s):

Issue: https://issues.redhat.com/browse/TELCODOCS-2647

Link to docs preview:https://106280--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/advanced_networking/ptp/configuring-ptp.html

QE review:

QE has approved this change.

Additional information: Resolve all AsciiDocDITA errors across 28 files in the configuring-ptp assembly to prepare for DITA conversion:

Add [role="_abstract"] short descriptions to 27 modules

Transform callout lists to definition/bulleted lists in 9 modules

Convert example block delimiters (====) to open blocks (--) for NOTE/IMPORTANT admonitions and remove [%collapsible] wrappers

Fix misspelled .Prerequisties block title in nw-ptp-device-discovery

Connect loose paragraphs to procedure steps with + continuations

Remove descriptive text from Additional resources link in assembly

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 · 2026-02-18T11:47:49Z

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

Details

In response to this:

[TELCODOCS-2647]: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly

Version(s): 4.16+

Issue: https://issues.redhat.com/browse/TELCODOCS-2647

Link to docs preview:https://106280--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/advanced_networking/ptp/configuring-ptp.html

QE review:

QE has approved this change.

Additional information: Resolve all AsciiDocDITA errors across 28 files in the configuring-ptp assembly to prepare for DITA conversion:

Add [role="_abstract"] short descriptions to 27 modules

Transform callout lists to definition/bulleted lists in 9 modules

Convert example block delimiters (====) to open blocks (--) for NOTE/IMPORTANT admonitions and remove [%collapsible] wrappers

Fix misspelled .Prerequisties block title in nw-ptp-device-discovery

Connect loose paragraphs to procedure steps with + continuations

Remove descriptive text from Additional resources link in assembly

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 · 2026-03-04T12:39:04Z

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

Details

In response to this:

[TELCODOCS-2647]: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly

Version(s): 4.20+

Issue: https://issues.redhat.com/browse/TELCODOCS-2647

Link to docs preview: https://106280--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/advanced_networking/ptp/configuring-ptp.html

QE review:

QE has approved this change.

Additional information: Resolve all AsciiDocDITA errors across 28 files in the configuring-ptp assembly to prepare for DITA conversion:

Add [role="_abstract"] short descriptions to 27 modules

Transform callout lists to definition/bulleted lists in 9 modules

Convert example block delimiters (====) to open blocks (--) for NOTE/IMPORTANT admonitions and remove [%collapsible] wrappers

Fix misspelled .Prerequisties block title in nw-ptp-device-discovery

Connect loose paragraphs to procedure steps with + continuations

Remove descriptive text from Additional resources link in assembly

Note: These are editorial/DITA-prep changes only - no technical content changes. A separate 4.16-specific PR will be created for the DITA conversion backport targeting only the modules that exist in 4.16.

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.

…backport) Backport DITA fixes from PR openshift#106280 to enterprise-4.16. Includes 22 modules with fixes for short descriptions, callout transforms, block delimiters, and other AsciiDocDITA rule violations.

…backport) Backport DITA fixes from PR openshift#106280 to enterprise-4.18. Includes 24 modules with fixes for short descriptions, callout transforms, block delimiters, and other AsciiDocDITA rule violations.

…backport) Backport DITA fixes from PR openshift#106280 to enterprise-4.19. Includes 24 modules with fixes for short descriptions, callout transforms, block delimiters, and other AsciiDocDITA rule violations.

…backport) Backport DITA fixes from PR openshift#106280 to enterprise-4.17. Includes 22 modules with fixes for short descriptions, callout transforms, block delimiters, and other AsciiDocDITA rule violations.

slovern · 2026-03-06T10:22:32Z

modules/ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic.adoc

-<1> Specify the required interfaces to start `ptp4l` as a boundary clock. For example, `ens5f0` synchronizes from a grandmaster clock and `ens5f1` synchronizes connected devices.
-<2> Set `phc2sysOpts` with an empty string.
+
+- `spec.profile.ptp4lConf` specify the required interfaces to start `ptp4l` as a boundary clock. For example, `ens5f0` synchronizes from a grandmaster clock and `ens5f1` synchronizes connected devices.


Hey what's missing ? @slovern

slovern

A few comments on this one - mostly relating to how Claude has done the callouts

modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc

modules/cnf-getting-the-dpll-firmware-version-for-intel-800-series-nics.adoc

modules/nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-three-nic.adoc

modules/nw-ptp-configuring-linuxptp-services-dual-port-oc.adoc

modules/nw-ptp-e810-hardware-configuration-reference.adoc

modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc

modules/nw-ptp-configuring-linuxptp-services-dual-port-oc.adoc

modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc

modules/ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic.adoc

Backport of PR openshift#106280 to enterprise-4.19. 23 files changed, 3 files excluded (not present on enterprise-4.19): - cnf-configuring-enhanced-log-filtering-for-linuxptp (4.20+) - cnf-configuring-log-reduction-for-linuxptp (4.20+) - nw-ptp-t-bc-t-tsc-holdover (4.20+) 1 conflict resolved: - cnf-configuring-log-filtering-for-linuxptp.adoc: applied abstract rewrite Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc

modules/ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic.adoc

Backport of PR openshift#106280 to enterprise-4.16. 22 files included, 6 files excluded (not present on enterprise-4.16): - cnf-configuring-enhanced-log-filtering-for-linuxptp (4.20+) - cnf-configuring-log-reduction-for-linuxptp (4.20+) - nw-ptp-t-bc-t-tsc-holdover (4.20+) - nw-ptp-configuring-linuxptp-services-dual-port-oc (4.18+) - nw-ptp-holdover-in-a-grandmaster-clock (4.18+) - networking/advanced_networking/ptp/configuring-ptp.adoc (4.17+, 4.16 uses networking/ptp/ path) 5 conflicts resolved: - cnf-configuring-log-filtering-for-linuxptp.adoc: applied abstract rewrite - nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-dual-nic.adoc: applied NOTE delimiter and text fixes - nw-ptp-dual-wpc-hardware-config-reference.adoc: applied abstract + added pin format reference - nw-ptp-e810-hardware-configuration-reference.adoc: applied abstract rewrite - configuring-ptp.adoc: kept 4.16-correct xref paths Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Resolve all AsciiDocDITA errors across 28 files in the configuring-ptp assembly to prepare for DITA conversion: - Add [role="_abstract"] short descriptions to 27 modules - Transform callout lists to definition/bulleted lists in 9 modules - Convert example block delimiters (====) to open blocks (--) for NOTE/IMPORTANT admonitions and remove [%collapsible] wrappers - Fix misspelled .Prerequisties block title in nw-ptp-device-discovery - Connect loose paragraphs to procedure steps with + continuations - Remove descriptive text from Additional resources link in assembly Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

openshift-ci · 2026-03-13T13:07:03Z

@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 · 2026-03-13T14:46:54Z

/cherrypick enterprise-4.22

slovern · 2026-03-13T14:47:01Z

/cherrypick enterprise-4.21

slovern · 2026-03-13T14:47:08Z

/cherrypick enterprise-4.20

openshift-cherrypick-robot · 2026-03-13T14:47:48Z

@slovern: new pull request created: #108324

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 · 2026-03-13T14:47:52Z

@slovern: new pull request created: #108325

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 · 2026-03-13T14:47:54Z

@slovern: #106280 failed to apply on top of branch "enterprise-4.20":

Applying: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly
.git/rebase-apply/patch:525: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	modules/cnf-about-collecting-ptp-data.adoc
M	modules/cnf-troubleshooting-common-ptp-operator-issues.adoc
M	modules/nw-ptp-t-bc-t-tsc-holdover.adoc
M	networking/advanced_networking/ptp/configuring-ptp.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/nw-ptp-t-bc-t-tsc-holdover.adoc
CONFLICT (content): Merge conflict in modules/nw-ptp-t-bc-t-tsc-holdover.adoc
Auto-merging modules/cnf-troubleshooting-common-ptp-operator-issues.adoc
Auto-merging modules/cnf-about-collecting-ptp-data.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly

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.

Backport of openshift#106280 to enterprise-4.19. 25 files included, 3 files excluded. 1 conflict(s) resolved. Excluded (not present on enterprise-4.19): - cnf-configuring-enhanced-log-filtering-for-linuxptp - cnf-configuring-log-reduction-for-linuxptp - nw-ptp-t-bc-t-tsc-holdover Conflicts resolved: - cnf-configuring-log-filtering-for-linuxptp.adoc: applied abstract rewrite (replaced verbose description with [role="_abstract"] short description) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Backport of openshift#106280 to enterprise-4.18. 25 files included, 3 files excluded. 1 conflict(s) resolved. Excluded (not present on enterprise-4.18): - cnf-configuring-enhanced-log-filtering-for-linuxptp - cnf-configuring-log-reduction-for-linuxptp - nw-ptp-t-bc-t-tsc-holdover Conflicts resolved: - cnf-configuring-log-filtering-for-linuxptp.adoc: applied abstract rewrite Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Backport of openshift#106280 to enterprise-4.17. 23 files included, 5 files excluded. 1 conflict(s) resolved. Excluded (not present on enterprise-4.17): - cnf-configuring-enhanced-log-filtering-for-linuxptp - cnf-configuring-log-reduction-for-linuxptp - nw-ptp-configuring-linuxptp-services-dual-port-oc - nw-ptp-holdover-in-a-grandmaster-clock - nw-ptp-t-bc-t-tsc-holdover Conflicts resolved: - cnf-configuring-log-filtering-for-linuxptp.adoc: applied abstract rewrite Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Backport of openshift#106280 to enterprise-4.16. 22 files included, 6 files excluded. 4 conflict(s) resolved. Excluded (not present on enterprise-4.16): - cnf-configuring-enhanced-log-filtering-for-linuxptp - cnf-configuring-log-reduction-for-linuxptp - nw-ptp-configuring-linuxptp-services-dual-port-oc - nw-ptp-holdover-in-a-grandmaster-clock - nw-ptp-t-bc-t-tsc-holdover - networking/advanced_networking/ptp/configuring-ptp.adoc (exists at networking/ptp/ — no changes needed) Conflicts resolved: - cnf-configuring-log-filtering-for-linuxptp.adoc: applied abstract rewrite - nw-ptp-configuring-linuxptp-services-as-grandmaster-clock-dual-nic.adoc: applied ==== to -- delimiter fix, kept 4.16 E810-XXVDA4T product name - nw-ptp-dual-wpc-hardware-config-reference.adoc: applied abstract tag, kept 4.16 E810-XXVDA4T product name, added pin format reference content - nw-ptp-e810-hardware-configuration-reference.adoc: applied abstract tag, kept 4.16 E810-XXVDA4T product name Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 10, 2026

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 10, 2026

kquinn1204 force-pushed the TELCODOCS-2647 branch from 6e79f00 to 9a82af5 Compare February 10, 2026 15:16

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 10, 2026

kquinn1204 changed the title ~~Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly~~ TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly Feb 17, 2026

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 17, 2026

kquinn1204 force-pushed the TELCODOCS-2647 branch 3 times, most recently from 13dd63d to b730e93 Compare February 18, 2026 11:46

kquinn1204 force-pushed the TELCODOCS-2647 branch from 0319ad2 to b80294f Compare March 4, 2026 11:22

kquinn1204 mentioned this pull request Mar 4, 2026

TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP modules (4.16) #107889

Closed

kquinn1204 mentioned this pull request Mar 4, 2026

TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP modules (4.18) #107890

Closed

kquinn1204 mentioned this pull request Mar 4, 2026

TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP modules (4.19) #107891

Closed

kquinn1204 mentioned this pull request Mar 4, 2026

TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP modules (4.17) #107896

Closed

slovern reviewed Mar 6, 2026

View reviewed changes

ocpdocs-vale-bot reviewed Mar 6, 2026

View reviewed changes

modules/cnf-configuring-fifo-priority-scheduling-for-ptp.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Mar 6, 2026

View reviewed changes

modules/nw-ptp-configuring-linuxptp-services-dual-port-oc.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Mar 6, 2026

View reviewed changes

modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Mar 6, 2026

View reviewed changes

modules/ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic.adoc Show resolved Hide resolved

kquinn1204 force-pushed the TELCODOCS-2647 branch from 4991bba to b1fa069 Compare March 10, 2026 14:51

ocpdocs-vale-bot reviewed Mar 10, 2026

View reviewed changes

modules/ptp-configuring-linuxptp-services-as-boundary-clock-dual-nic.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Mar 10, 2026

View reviewed changes

modules/ptp-configuring-linuxptp-services-as-ha-bc-for-dual-nic.adoc Show resolved Hide resolved

kquinn1204 mentioned this pull request Mar 10, 2026

TELCODOCS-2647: Backport DITA-prep fixes to enterprise-4.17 #108150

Closed

1 task

kquinn1204 mentioned this pull request Mar 10, 2026

TELCODOCS-2647: Backport DITA-prep fixes to enterprise-4.16 #108151

Closed

1 task

kquinn1204 force-pushed the TELCODOCS-2647 branch from d8eb4dd to d6ac008 Compare March 13, 2026 12:55

slovern added branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 labels Mar 13, 2026

slovern added this to the Continuous Release milestone Mar 13, 2026

slovern merged commit 7d16102 into openshift:main Mar 13, 2026
2 checks passed

openshift-cherrypick-robot mentioned this pull request Mar 13, 2026

[enterprise-4.22] TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly #108324

Merged

openshift-cherrypick-robot mentioned this pull request Mar 13, 2026

[enterprise-4.21] TELCODOCS-2647: Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly #108325

Merged

kquinn1204 mentioned this pull request Mar 13, 2026

Fix AsciiDocDITA rule violations in PTP configuring-ptp assembly #108335

Merged

1 task

Conversation

kquinn1204 commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Feb 17, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Feb 18, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Mar 4, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slovern Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

kquinn1204 Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

slovern left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci bot commented Mar 13, 2026

Uh oh!

Uh oh!

slovern commented Mar 13, 2026

Uh oh!

slovern commented Mar 13, 2026

Uh oh!

slovern commented Mar 13, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 13, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 13, 2026

Uh oh!

openshift-cherrypick-robot commented Mar 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

kquinn1204 commented Feb 10, 2026 •

edited

Loading

ocpdocs-previewbot commented Feb 10, 2026 •

edited

Loading

openshift-ci-robot commented Feb 17, 2026 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Feb 18, 2026 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Mar 4, 2026 •

edited by openshift-ci bot

Loading