Skip to content

OSDOCS-16940: DITA callouts — OLM topics#115356

Open
stevsmit wants to merge 2 commits into
openshift:mainfrom
stevsmit:osdocs-16940-dita-callouts-1
Open

OSDOCS-16940: DITA callouts — OLM topics#115356
stevsmit wants to merge 2 commits into
openshift:mainfrom
stevsmit:osdocs-16940-dita-callouts-1

Conversation

@stevsmit

@stevsmit stevsmit commented Jul 14, 2026

Copy link
Copy Markdown
Member

Summary

Replaces AsciiDoc callout markers and numbered callout lists with DITA-safe prose in three OLM modules (Pattern E where: lists, Pattern F output bullets, and single-callout explanatory sentences). Addresses AsciiDocDITA.CalloutList for the callouts series of OSDOCS-16940.

Jira

https://redhat.atlassian.net/browse/OSDOCS-16940

Versions

4.20+

Merge order

Independent branch from main (callouts only). Rebase if same-file conflicts with other OSDOCS-16940 series PRs.

Files changed

  • modules/olm-installing-from-software-catalog-using-cli.adoc
  • modules/olm-overriding-operatorconditions.adoc
  • modules/olm-preparing-multitenant-operators.adoc

Vale rules addressed

  • AsciiDocDITA.CalloutList

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@openshift-ci-robot

openshift-ci-robot commented Jul 14, 2026

Copy link
Copy Markdown

@stevsmit: This pull request references OSDOCS-16940 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:

Summary

Replaces AsciiDoc callout markers and numbered callout lists with DITA-safe prose in three OLM modules (Pattern E where: lists, Pattern F output bullets, and single-callout explanatory sentences). Addresses AsciiDocDITA.CalloutList for the callouts series of OSDOCS-16940.

Jira

https://redhat.atlassian.net/browse/OSDOCS-16940

Versions

4.20+

Merge order

Independent branch from main (callouts only). Rebase if same-file conflicts with other OSDOCS-16940 series PRs.

Files changed

  • modules/olm-installing-from-software-catalog-using-cli.adoc
  • modules/olm-overriding-operatorconditions.adoc
  • modules/olm-preparing-multitenant-operators.adoc

Vale rules addressed

  • AsciiDocDITA.CalloutList

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted

Made with Cursor

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 Jul 14, 2026
@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 14, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 14, 2026

Copy link
Copy Markdown

* The `Install Modes` section indicates which install modes are supported.
* `stable-3.7` and `stable-3.8` are example channel names.
* The `Default Channel` field is the channel selected by default if one is not specified.
====

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] AsciiDocDITA.ExampleBlock: Example blocks can not be inside of other blocks in DITA.

* The `Install Modes` section indicates which install modes are supported.
* `stable-3.7` and `stable-3.8` are example channel names.
* The `Default Channel` field is the channel selected by default if one is not specified.
====

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] AsciiDocDITA.TaskExample: Examples are allowed only once in DITA tasks.

Preserve .Example output block titles and drop [%collapsible]/==== wrappers.
Fix command-then-output structure and avoid + after example titles.

Co-authored-by: Cursor <cursoragent@cursor.com>
@openshift-ci

openshift-ci Bot commented Jul 14, 2026

Copy link
Copy Markdown

@stevsmit: 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