OSDOCS-16939: DITA abstracts — OLM understanding topics#115281
Conversation
Rewrite ShortDescription abstracts and remove duplicative original intro paragraphs. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@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. DetailsIn response to this:
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. |
|
🤖 Mon Jul 13 20:30:01 - Prow CI generated the docs preview: |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ContentType: The '_mod-docs-content-type' attribute definition is missing.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ContentType: The '_mod-docs-content-type' attribute definition is missing.
There was a problem hiding this comment.
🤖 [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. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'compatible with earlier versions' rather than 'backwards compatible'. For more information, see RedHat.TermsErrors.
|
@stevsmit: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
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
Notes
Made with Cursor