Skip to content

OSDOCS-16941: DITA other Vale fixes for OLM catalog topics (batch 1)#115367

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

OSDOCS-16941: DITA other Vale fixes for OLM catalog topics (batch 1)#115367
stevsmit wants to merge 2 commits into
openshift:mainfrom
stevsmit:osdocs-16941-dita-other-vale-1

Conversation

@stevsmit

@stevsmit stevsmit commented Jul 14, 2026

Copy link
Copy Markdown
Member

Summary

  • Resolves AsciiDocDITA Vale rules (ConceptLink, RelatedLinks, AssemblyContents, ContentType, TaskStep, TaskTitle, ExampleBlock) for OLM catalog and configuration topics in scope of OSDOCS-16941.
  • Moves assembly xrefs and module links into Additional resources; extracts SQLite-based catalogs section into a new module for AssemblyContents compliance.
  • Adds _mod-docs-content-type: CONCEPT and document title to deprecated-feature.adoc snippet module.

Scope

This PR covers the "other Vale" batch only. Abstracts and CalloutList fixes are handled separately in other PRs.

Test plan

  • vale --config=.vale.ini passes for target AsciiDocDITA rules on all changed files
  • Diff vs upstream/main is 298 lines (under 499 limit)
  • AsciiDoc build/preview for affected OLM catalog topics

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

  • Resolves AsciiDocDITA Vale rules (ConceptLink, RelatedLinks, AssemblyContents, ContentType, TaskStep, TaskTitle, ExampleBlock) for OLM catalog and configuration topics in scope of OSDOCS-16941.
  • Moves assembly xrefs and module links into Additional resources; extracts SQLite-based catalogs section into a new module for AssemblyContents compliance.
  • Adds _mod-docs-content-type: CONCEPT and document title to deprecated-feature.adoc snippet module.

Scope

This PR covers the "other Vale" batch only. Abstracts and CalloutList fixes are handled separately in other PRs.

Test plan

  • vale --config=.vale.ini passes for target AsciiDocDITA rules on all changed files
  • Diff vs upstream/main is 298 lines (under 499 limit)
  • AsciiDoc build/preview for affected OLM catalog topics

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 14, 2026
@stevsmit stevsmit force-pushed the osdocs-16941-dita-other-vale-1 branch from 2c319b0 to 319a3bd Compare July 14, 2026 15:34
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 14, 2026

Copy link
Copy Markdown

🤖 Tue Jul 14 18:44:10 - Prow CI generated the docs preview:
https://115367--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@stevsmit stevsmit force-pushed the osdocs-16941-dita-other-vale-1 branch from 319a3bd to bffe71f Compare July 14, 2026 17:45
@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 14, 2026
@stevsmit stevsmit force-pushed the osdocs-16941-dita-other-vale-1 branch from bffe71f to 4dcfe9d Compare July 14, 2026 18:07
@openshift-ci openshift-ci Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 14, 2026
@stevsmit stevsmit force-pushed the osdocs-16941-dita-other-vale-1 branch from 4dcfe9d to 0573387 Compare July 14, 2026 18:10
Move links and xrefs to Additional resources, resolve AssemblyContents and
TaskStep/TaskTitle issues, and set SNIPPET content type for deprecated-feature.

Co-authored-by: Cursor <cursoragent@cursor.com>
@stevsmit stevsmit force-pushed the osdocs-16941-dita-other-vale-1 branch from 0573387 to 5841c34 Compare July 14, 2026 18:10
@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 14, 2026
Replace lead-in sentences with .Example output and avoid lone + after
example titles for AsciiDocDITA ExampleBlock compliance.

Co-authored-by: Cursor <cursoragent@cursor.com>
@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