Skip to content

OSDOCS-16940: DITA abstracts — OLM admin/user topics#115359

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

OSDOCS-16940: DITA abstracts — OLM admin/user topics#115359
stevsmit wants to merge 1 commit into
openshift:mainfrom
stevsmit:osdocs-16940-dita-abstracts-1

Conversation

@stevsmit

@stevsmit stevsmit commented Jul 14, 2026

Copy link
Copy Markdown
Member

Summary

Adds rewritten DITA short descriptions ([role="_abstract"]) to 20 OLM admin and user assembly/module topics for OSDOCS-16940. Duplicative intro paragraphs were removed where the new abstract covers the same intent.

Jira

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

Versions

4.20+

Merge order

Independent branch from main (abstracts only). No dependency on other OSDOCS-16940 series PRs.

Files changed

  • modules/olm-changing-update-channel.adoc
  • modules/olm-creating-etcd-cluster-from-operator.adoc
  • modules/olm-deleting-operators-from-a-cluster-using-cli.adoc
  • modules/olm-installing-from-software-catalog-using-cli.adoc
  • modules/olm-installing-from-software-catalog-using-web-console.adoc
  • modules/olm-installing-global-namespaces.adoc
  • modules/olm-installing-operators-from-software-catalog.adoc
  • modules/olm-overriding-operatorconditions.adoc
  • modules/olm-pod-placement.adoc
  • modules/olm-preparing-multitenant-operators.adoc
  • modules/olm-preparing-upgrade.adoc
  • modules/olm-updating-use-operatorconditions.adoc
  • operators/admin/olm-adding-operators-to-cluster.adoc
  • operators/admin/olm-deleting-operators-from-cluster.adoc
  • operators/admin/olm-managing-operatorconditions.adoc
  • operators/admin/olm-status.adoc
  • operators/admin/olm-troubleshooting-operator-issues.adoc
  • operators/admin/olm-upgrading-operators.adoc
  • operators/user/olm-creating-apps-from-installed-operators.adoc
  • operators/user/olm-installing-operators-in-namespace.adoc

Vale rules addressed

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted
  • 20 files changed, 109 lines (43 insertions, 66 deletions)

Made with Cursor

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

Adds rewritten DITA short descriptions ([role="_abstract"]) to 20 OLM admin and user assembly/module topics for OSDOCS-16940. Duplicative intro paragraphs were removed where the new abstract covers the same intent.

Jira

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

Versions

4.20+

Merge order

Independent branch from main (abstracts only). No dependency on other OSDOCS-16940 series PRs.

Files changed

  • modules/olm-changing-update-channel.adoc
  • modules/olm-creating-etcd-cluster-from-operator.adoc
  • modules/olm-deleting-operators-from-a-cluster-using-cli.adoc
  • modules/olm-installing-from-software-catalog-using-cli.adoc
  • modules/olm-installing-from-software-catalog-using-web-console.adoc
  • modules/olm-installing-global-namespaces.adoc
  • modules/olm-installing-operators-from-software-catalog.adoc
  • modules/olm-overriding-operatorconditions.adoc
  • modules/olm-pod-placement.adoc
  • modules/olm-preparing-multitenant-operators.adoc
  • modules/olm-preparing-upgrade.adoc
  • modules/olm-updating-use-operatorconditions.adoc
  • operators/admin/olm-adding-operators-to-cluster.adoc
  • operators/admin/olm-deleting-operators-from-cluster.adoc
  • operators/admin/olm-managing-operatorconditions.adoc
  • operators/admin/olm-status.adoc
  • operators/admin/olm-troubleshooting-operator-issues.adoc
  • operators/admin/olm-upgrading-operators.adoc
  • operators/user/olm-creating-apps-from-installed-operators.adoc
  • operators/user/olm-installing-operators-in-namespace.adoc

Vale rules addressed

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted
  • 20 files changed, 109 lines (43 insertions, 66 deletions)

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
Add [role="_abstract"] short descriptions to 20 OLM assembly and module
topics, rewriting duplicative intros per DITA abstract guidelines.

Co-authored-by: Cursor <cursoragent@cursor.com>
@stevsmit stevsmit force-pushed the osdocs-16940-dita-abstracts-1 branch from 74dc3b9 to 9c3cc5a Compare July 14, 2026 14:48
@ocpdocs-previewbot

Copy link
Copy Markdown

🤖 Tue Jul 14 15:06:29 - Prow CI generated the docs preview:
https://115359--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

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

3 participants