Skip to content

OSDOCS-16939: DITA abstracts — OLM understanding topics#115281

Open
stevsmit wants to merge 1 commit into
openshift:mainfrom
stevsmit:osdocs-16939-dita-abstracts-1
Open

OSDOCS-16939: DITA abstracts — OLM understanding topics#115281
stevsmit wants to merge 1 commit into
openshift:mainfrom
stevsmit:osdocs-16939-dita-abstracts-1

Conversation

@stevsmit

Copy link
Copy Markdown
Member

Summary

Rewrites [role="_abstract"] short descriptions across 48 OLM understanding assemblies and modules. Removes duplicative intro paragraphs that restate the abstract.

Jira

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

Versions

4.20+

Merge order

Independent branch from main. Preferred merge after split PR if same-file conflicts; rebase if needed.

Vale rules addressed

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)

Made with Cursor

Rewrite ShortDescription abstracts and remove duplicative original intro paragraphs.

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

openshift-ci-robot commented Jul 13, 2026

Copy link
Copy Markdown

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

Summary

Rewrites [role="_abstract"] short descriptions across 48 OLM understanding assemblies and modules. Removes duplicative intro paragraphs that restate the abstract.

Jira

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

Versions

4.20+

Merge order

Independent branch from main. Preferred merge after split PR if same-file conflicts; rebase if needed.

Vale rules addressed

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)

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

Copy link
Copy Markdown

🤖 Mon Jul 13 20:30:01 - Prow CI generated the docs preview:
https://115281--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

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] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

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.ContentType: The '_mod-docs-content-type' attribute definition is missing.

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.ContentType: The '_mod-docs-content-type' attribute definition is missing.

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] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.


_File-based catalogs_ are the latest iteration of the catalog format in Operator Lifecycle Manager (OLM). It is a plain text-based (JSON or YAML) and declarative config evolution of the earlier SQLite database format, and it is fully backwards compatible. The goal of this format is to enable Operator catalog editing, composability, and extensibility.
[role="_abstract"]
File-based catalogs are the latest plain text (JSON or YAML) catalog format for Operator Lifecycle Manager (OLM) on {product-title}. This format enables catalog editing, composability, and extensibility while remaining backwards compatible with earlier SQLite-based catalogs.

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 'compatible with earlier versions' rather than 'backwards compatible'. For more information, see RedHat.TermsErrors.

@openshift-ci

openshift-ci Bot commented Jul 13, 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