Skip to content

OSDOCS-16939: DITA other-vale — OLM RelatedLinks and AssemblyContents#115282

Open
stevsmit wants to merge 2 commits into
openshift:mainfrom
stevsmit:osdocs-16939-dita-other-vale-1
Open

OSDOCS-16939: DITA other-vale — OLM RelatedLinks and AssemblyContents#115282
stevsmit wants to merge 2 commits into
openshift:mainfrom
stevsmit:osdocs-16939-dita-other-vale-1

Conversation

@stevsmit

Copy link
Copy Markdown
Member

Summary

Fixes remaining AsciiDocDITA issues: RelatedLinks, ConceptLink, ExampleBlock, AssemblyContents. Extracts multitenancy colocation to a module; moves xref: to assembly .Additional resources under that include.

Jira

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

Versions

4.20+

Merge order

Independent branch from main. Merge after split #115280 and callouts #115282 if same-file conflicts; rebase if needed. Packaging-format assembly in split PR.

Files changed

  • modules/olm-architecture.adoc
  • modules/olm-catalogsource-image-template.adoc
  • modules/olm-catalogsource.adoc
  • modules/olm-fb-catalogs-prop.adoc
  • modules/olm-fb-catalogs.adoc
  • modules/olm-multitenancy-colocation.adoc
  • modules/olm-multitenancy-solution.adoc
  • modules/olm-operatorgroups-rbac.adoc
  • operators/understanding/olm-multitenancy.adoc

Vale rules addressed

  • AsciiDocDITA.RelatedLinks
  • AsciiDocDITA.ConceptLink
  • AsciiDocDITA.ExampleBlock
  • AsciiDocDITA.AssemblyContents

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • xref: never in modules

Made with Cursor

RelatedLinks, ConceptLink, ExampleBlock, AssemblyContents fixes; colocation module with xrefs in assembly only.

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

Fixes remaining AsciiDocDITA issues: RelatedLinks, ConceptLink, ExampleBlock, AssemblyContents. Extracts multitenancy colocation to a module; moves xref: to assembly .Additional resources under that include.

Jira

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

Versions

4.20+

Merge order

Independent branch from main. Merge after split #115280 and callouts #115282 if same-file conflicts; rebase if needed. Packaging-format assembly in split PR.

Files changed

  • modules/olm-architecture.adoc
  • modules/olm-catalogsource-image-template.adoc
  • modules/olm-catalogsource.adoc
  • modules/olm-fb-catalogs-prop.adoc
  • modules/olm-fb-catalogs.adoc
  • modules/olm-multitenancy-colocation.adoc
  • modules/olm-multitenancy-solution.adoc
  • modules/olm-operatorgroups-rbac.adoc
  • operators/understanding/olm-multitenancy.adoc

Vale rules addressed

  • AsciiDocDITA.RelatedLinks
  • AsciiDocDITA.ConceptLink
  • AsciiDocDITA.ExampleBlock
  • AsciiDocDITA.AssemblyContents

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • xref: never in modules

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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 13, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 13, 2026

Copy link
Copy Markdown

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

Comment thread modules/olm-fb-catalogs.adoc Outdated
.Additional resources

ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom 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] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

Comment thread modules/olm-fb-catalogs.adoc Outdated

ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs]
* xref:../disconnected/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]

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.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

Comment thread modules/olm-fb-catalogs.adoc Outdated
* xref:../disconnected/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom 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] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

Strip xref bullets from olm-fb-catalogs module; place them in
olm-packaging-format under the module include. Keep IMPORTANT block
in the module without inline xrefs.

Co-authored-by: Cursor <cursoragent@cursor.com>
@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/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants