OSDOCS-16939: DITA split-modules — olm packaging format

[stevsmit]

Summary

Splits NestedSection content for Operator Framework packaging format into child modules with preserved leveloffset nesting (=== sections use parent+2). Applies abstracts, callout rewrite, BlockTitle lead-ins on new topics. Moves xref: from olm-fb-catalogs-cli module to assembly .Additional resources under that include.

Jira

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

Versions

4.20+

Merge order

First PR for NestedSection; targets openshift:main. Preferred merge before abstracts/callouts/other-vale PRs that touch overlapping assemblies.

Files changed

• modules/olm-bundle-format.adoc
• modules/olm-bundle-format-manifests.adoc
• modules/olm-bundle-format-manifests-optional.adoc (leveloffset=+3)
• modules/olm-bundle-format-annotations.adoc
• modules/olm-fb-catalogs-cli.adoc
• operators/understanding/olm-packaging-format.adoc

Vale rules addressed

• AsciiDocDITA.NestedSection
• AsciiDocDITA.ContentType
• AsciiDocDITA.ShortDescription (new modules)
• AsciiDocDITA.CalloutList (annotations)
• AsciiDocDITA.BlockTitle
• AsciiDocDITA.ConceptLink (xrefs in assembly only)

Notes

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

Made with Cursor

[openshift-ci-robot]

@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

Splits NestedSection content for Operator Framework packaging format into child modules with preserved leveloffset nesting (=== sections use parent+2). Applies abstracts, callout rewrite, BlockTitle lead-ins on new topics. Moves xref: from olm-fb-catalogs-cli module to assembly .Additional resources under that include.

Jira

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

Versions

4.20+

Merge order

First PR for NestedSection; targets openshift:main. Preferred merge before abstracts/callouts/other-vale PRs that touch overlapping assemblies.

Files changed

• modules/olm-bundle-format.adoc
• modules/olm-bundle-format-manifests.adoc
• modules/olm-bundle-format-manifests-optional.adoc (leveloffset=+3)
• modules/olm-bundle-format-annotations.adoc
• modules/olm-fb-catalogs-cli.adoc
• operators/understanding/olm-packaging-format.adoc

Vale rules addressed

• AsciiDocDITA.NestedSection
• AsciiDocDITA.ContentType
• AsciiDocDITA.ShortDescription (new modules)
• AsciiDocDITA.CalloutList (annotations)
• AsciiDocDITA.BlockTitle
• AsciiDocDITA.ConceptLink (xrefs in assembly only)

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.

[ocpdocs-previewbot]

🤖 Mon Jul 13 20:28:30 - Prow CI generated the docs preview:

https://115280--ocpdocs-pr.netlify.app/openshift-dedicated/latest/operators/understanding/olm-packaging-format.html
https://115280--ocpdocs-pr.netlify.app/openshift-enterprise/latest/operators/understanding/olm-packaging-format.html
https://115280--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/operators/understanding/olm-packaging-format.html
https://115280--ocpdocs-pr.netlify.app/openshift-rosa/latest/operators/understanding/olm-packaging-format.html

[openshift-ci]

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