Skip to content

OSDOCS-16941: Fix DITA CalloutList in OLM modules (batch 1)#115365

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

OSDOCS-16941: Fix DITA CalloutList in OLM modules (batch 1)#115365
stevsmit wants to merge 2 commits into
openshift:mainfrom
stevsmit:osdocs-16941-dita-callouts-1

Conversation

@stevsmit

Copy link
Copy Markdown
Member

Summary

  • Replace AsciiDoc callout markers with DITA-safe prose in 10 OLM modules
  • Apply Pattern E where: description lists, Pattern A Replace sentences, and Pattern F output bullets per callout rewrite ruleset
  • Vale CalloutList clean on all changed files (274-line diff)

Files changed

  • modules/olm-accessing-images-private-registries.adoc
  • modules/olm-creating-catalog-from-index.adoc
  • modules/olm-creating-fb-catalog-image.adoc
  • modules/olm-creating-index-image.adoc
  • modules/olm-disabling-copied-csvs.adoc
  • modules/olm-injecting-custom-ca.adoc
  • modules/olm-pruning-index-image.adoc
  • modules/olm-software-catalog-architecture.adoc
  • modules/olm-sqlite-catalog-configuring-elevated-permissions.adoc
  • modules/olm-updating-index-image.adoc

Test plan

  • vale --config=.vale.ini reports no CalloutList violations on all 10 files
  • Diff is 274 lines (under 499-line limit)
  • DITA build passes in CI

Made with Cursor

Replace AsciiDoc callout markers with DITA-safe Pattern E where: lists
and other callout rewrite patterns across 10 OLM procedure modules.

Co-authored-by: Cursor <cursoragent@cursor.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 Jul 14, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 14, 2026

Copy link
Copy Markdown

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

  • Replace AsciiDoc callout markers with DITA-safe prose in 10 OLM modules
  • Apply Pattern E where: description lists, Pattern A Replace sentences, and Pattern F output bullets per callout rewrite ruleset
  • Vale CalloutList clean on all changed files (274-line diff)

Files changed

  • modules/olm-accessing-images-private-registries.adoc
  • modules/olm-creating-catalog-from-index.adoc
  • modules/olm-creating-fb-catalog-image.adoc
  • modules/olm-creating-index-image.adoc
  • modules/olm-disabling-copied-csvs.adoc
  • modules/olm-injecting-custom-ca.adoc
  • modules/olm-pruning-index-image.adoc
  • modules/olm-software-catalog-architecture.adoc
  • modules/olm-sqlite-catalog-configuring-elevated-permissions.adoc
  • modules/olm-updating-index-image.adoc

Test plan

  • vale --config=.vale.ini reports no CalloutList violations on all 10 files
  • Diff is 274 lines (under 499-line limit)
  • DITA build passes in CI

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

🤖 Tue Jul 14 18:41:43 - Prow CI generated the docs preview:
https://115365--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

<4> Specify your index image. If you specify a tag after the image name, for example `:{tag}`, the catalog source pod uses an image pull policy of `Always`, meaning the pod always pulls the image prior to starting the container. If you specify a digest, for example `@sha256:<id>`, the image pull policy is `IfNotPresent`, meaning the pod pulls the image only if it does not already exist on the node.
<5> Specify your name or an organization name publishing the catalog.
<6> Catalog sources can automatically check for new versions to keep up to date.
`spec.image`:: Specifies your index image. If you specify a tag after the image name, for example `:{tag}`, the catalog source pod uses an image pull policy of `Always`, meaning the pod always pulls the image prior to starting the container. If you specify a digest, for example `@sha256:<id>`, the image pull policy is `IfNotPresent`, meaning the pod pulls the image only if it does not already exist on the node.

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] RedHat.TermsErrors: Use 'before' rather than 'prior to'. For more information, see RedHat.TermsErrors.

Replace lead-in sentences with .Example output and omit + after the title.

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