Skip to content

OSDOCS-16939: Refactor AsciiDocDITA.CalloutList violations - #116861

Merged
michaelryanpeter merged 1 commit into
openshift:mainfrom
michaelryanpeter:cqa-osdocs-16939-3
Aug 7, 2026
Merged

OSDOCS-16939: Refactor AsciiDocDITA.CalloutList violations #116861
michaelryanpeter merged 1 commit into
openshift:mainfrom
michaelryanpeter:cqa-osdocs-16939-3

Conversation

@michaelryanpeter

@michaelryanpeter michaelryanpeter commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Version(s): 4.20+

Issue: OSDOCS-16939

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@michaelryanpeter michaelryanpeter added this to the Continuous Release milestone Jul 29, 2026
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 29, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 29, 2026 •
edited by openshift-ci Bot
Loading

Copy link
Copy Markdown

@michaelryanpeter: This pull request references OSDOCS-16939 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 story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

<!--- PR title format: [GH#][BZ#][OCPBUGS#][OSDOCS#]: --->

Version(s): 4.20+

Issue: OSDOCS-16939

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 29, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown

🤖 Wed Aug 05 15:36:55 - Prow CI generated the docs preview:

https://116861--ocpdocs-pr.netlify.app/openshift-dedicated/latest/operators/understanding/olm/olm-understanding-olm.html
https://116861--ocpdocs-pr.netlify.app/openshift-dedicated/latest/operators/understanding/olm-packaging-format.html
https://116861--ocpdocs-pr.netlify.app/openshift-enterprise/latest/extensions/catalogs/fbc.html
https://116861--ocpdocs-pr.netlify.app/openshift-enterprise/latest/operators/understanding/olm/olm-understanding-olm.html
https://116861--ocpdocs-pr.netlify.app/openshift-enterprise/latest/operators/understanding/olm-packaging-format.html
https://116861--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/operators/understanding/olm/olm-understanding-olm.html
https://116861--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/operators/understanding/olm-packaging-format.html
https://116861--ocpdocs-pr.netlify.app/openshift-rosa/latest/operators/understanding/olm/olm-understanding-olm.html
https://116861--ocpdocs-pr.netlify.app/openshift-rosa/latest/operators/understanding/olm-packaging-format.html

michaelryanpeter
michaelryanpeter commented Jul 29, 2026
View reviewed changes

@michaelryanpeter michaelryanpeter left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

added direct links

Comment thread modules/olm-catalogsource.adoc

@michaelryanpeter michaelryanpeter Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

https://116861--ocpdocs-pr.netlify.app/openshift-enterprise/latest/operators/understanding/olm/olm-understanding-olm.html#olm-catalogsource_olm-understanding-olm

Comment thread modules/olm-deprecations-schema.adoc

@michaelryanpeter michaelryanpeter Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@michaelryanpeter
OSDOCS-16939: Refactor AsciiDocDITA.CalloutList violations to DITA-co…
597fc1e 
…mpatible formats

Converts numbered callouts (<1>, <2>, ...) to DITA-compatible formats
per Red Hat SSG guidelines:

- modules/olm-catalogsource.adoc: 15-item callout list converted to a
  where: definition list (parallel YAML fields).
- modules/olm-deprecations-schema.adoc: 5-item callout list converted
  to a bulleted list (non-parallel requirements), collapsible wrapper
  removed.

Format-only migration -- no content, wording, or conditional changes.
Split out from OSDOCS-16939 review (PRs 116697/116698) so DITA-compliance
review doesn't require digging through unrelated abstract/wording changes.
@openshift-ci

openshift-ci Bot commented Aug 5, 2026

Copy link
Copy Markdown

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

@stevsmit

stevsmit commented Aug 6, 2026

Copy link
Copy Markdown
Member

lgtm!

@michaelryanpeter
michaelryanpeter merged commit da7adfb into openshift:main Aug 7, 2026
2 checks passed
@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-5.0

@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.22

@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.21

@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.20

@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-5.0

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 7, 2026

Copy link
Copy Markdown

@michaelryanpeter: new pull request created: #117528

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 7, 2026
Merged
@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.22

@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.21

@michaelryanpeter

michaelryanpeter commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.20

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 7, 2026

Copy link
Copy Markdown

@michaelryanpeter: new pull request created: #117529

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 mentioned this pull request Aug 7, 2026
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 7, 2026

Copy link
Copy Markdown

@michaelryanpeter: new pull request created: #117530

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 Aug 7, 2026
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 7, 2026

Copy link
Copy Markdown

@michaelryanpeter: new pull request created: #117531

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 Aug 7, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

5 participants

@michaelryanpeter @openshift-ci-robot @ocpdocs-previewbot @stevsmit @openshift-cherrypick-robot