Skip to content

Fix ConceptLink warnings in virt/about_virt documentation#111741

Open
abrennan89 wants to merge 1 commit into
openshift:mainfrom
abrennan89:virt-concept-about_virt
Open

Fix ConceptLink warnings in virt/about_virt documentation#111741
abrennan89 wants to merge 1 commit into
openshift:mainfrom
abrennan89:virt-concept-about_virt

Conversation

@abrennan89
Copy link
Copy Markdown
Contributor

@abrennan89 abrennan89 commented May 15, 2026

Summary

This PR fixes AsciiDocDITA.ConceptLink warnings in the virt/about_virt documentation by:

  • Moving links and cross-references to Additional resources sections in assembly files
  • Removing links from module and snippet files to comply with documentation standards
  • Applying proper formatting when replacing links in text

Preview links:

Version:
4.20+

Jira:
TBA

Related

Part of splitting PR #111736 into smaller, subdirectory-focused PRs for easier review.

🤖 Generated with Claude Code

@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 15, 2026
Comment thread virt/about_virt/about-virt.adoc
Comment thread virt/about_virt/about-virt.adoc Outdated
Comment thread virt/about_virt/about-virt.adoc Outdated
Comment thread virt/about_virt/about-virt.adoc Outdated
Comment thread virt/about_virt/virt-security-policies.adoc
Comment thread virt/about_virt/virt-security-policies.adoc Outdated
Comment thread virt/about_virt/virt-supported-limits.adoc
abrennan89 added a commit to abrennan89/openshift-docs that referenced this pull request May 15, 2026
- Restore [role="_abstract"] attributes that were incorrectly removed
- Remove blank line between Additional resources heading and list
- Update link text to match actual document titles
- Remove duplicate xref entry

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@abrennan89
Copy link
Copy Markdown
Contributor Author

All review comments addressed:

  • ✅ Restored [role="_abstract"] attributes in all three assembly files
  • ✅ Removed blank line between Additional resources heading and list
  • ✅ Updated link text to match actual document titles:
    • Changed "profiles" to "Supported compliance profiles"
    • Changed "the Red Hat Ecosystem Catalog" to "Red Hat Ecosystem Catalog"
  • ✅ Removed duplicate xref to using-rbac.adoc (kept the one with proper title)

Ready for another review!

Comment thread modules/virt-tested-maximums.adoc Outdated
Comment thread virt/about_virt/about-virt.adoc Outdated
Comment thread virt/about_virt/about-virt.adoc Outdated
abrennan89 added a commit to abrennan89/openshift-docs that referenced this pull request May 15, 2026
- Add quotation marks around 'Virtualization limits for Red Hat Enterprise Linux with KVM' in module
- Update link text to match actual document titles:
  - 'OVN-Kubernetes' → 'About the OVN-Kubernetes network plugin'
  - 'Compliance Operator' → 'Understanding the Compliance Operator'
- Move KVM limits link to Additional resources in assembly

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@abrennan89
Copy link
Copy Markdown
Contributor Author

Final review suggestions applied:

modules/virt-tested-maximums.adoc

  • Added quotation marks around "Virtualization limits for Red Hat Enterprise Linux with KVM"

virt/about_virt/about-virt.adoc

  • Updated "OVN-Kubernetes" → "About the OVN-Kubernetes network plugin"
  • Updated "Compliance Operator" → "Understanding the Compliance Operator"

virt/about_virt/virt-supported-limits.adoc

  • Added KVM limits link to Additional resources section

All link text now matches actual document titles. Ready for final review!

abrennan89 added a commit to abrennan89/openshift-docs that referenced this pull request May 15, 2026
Move links and cross-references to Additional resources sections in assembly files.
Remove links from module and snippet files to comply with documentation standards.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Address PR review comments for openshift#111741

- Restore [role="_abstract"] attributes that were incorrectly removed
- Remove blank line between Additional resources heading and list
- Update link text to match actual document titles
- Remove duplicate xref entry

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Apply final review suggestions for openshift#111741

- Add quotation marks around 'Virtualization limits for Red Hat Enterprise Linux with KVM' in module
- Update link text to match actual document titles:
  - 'OVN-Kubernetes' → 'About the OVN-Kubernetes network plugin'
  - 'Compliance Operator' → 'Understanding the Compliance Operator'
- Move KVM limits link to Additional resources in assembly

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

fix conditional links
@abrennan89 abrennan89 force-pushed the virt-concept-about_virt branch from f1a7ddc to c758d6d Compare May 15, 2026 17:51
@abrennan89 abrennan89 added this to the Continuous Release milestone May 15, 2026
Comment thread virt/about_virt/about-virt.adoc Outdated
Comment thread virt/about_virt/about-virt.adoc Outdated
@abrennan89
Copy link
Copy Markdown
Contributor Author

Fixed AsciiDocDITA.AssemblyContents error and remaining issues:

Issues addressed:

  1. AsciiDocDITA.AssemblyContents error - "Content other than additional resources cannot follow include directives"

    • Moved OVN-Kubernetes, Compliance Operator, and Red Hat Ecosystem Catalog paragraphs from assembly to modules/virt-what-you-can-do-with-virt.adoc
    • Assembly now properly contains only: abstract, include directives, and Additional resources section
  2. Hardcoded ID - Changed [id="additional-resources_about-virt"] to [id="additional-resources_{context}"] to use context variable

Result:
Assembly structure now follows documentation standards:

  • Abstract
  • Include directives (modules only)
  • Additional resources section at end

All content with removed links has been moved to the appropriate module where it belongs.

Ready for review!

Move links and cross-references to Additional resources sections in assembly files.
Remove links from module and snippet files to comply with documentation standards.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Address PR review comments for openshift#111741

- Restore [role="_abstract"] attributes that were incorrectly removed
- Remove blank line between Additional resources heading and list
- Update link text to match actual document titles
- Remove duplicate xref entry

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Apply final review suggestions for openshift#111741

- Add quotation marks around 'Virtualization limits for Red Hat Enterprise Linux with KVM' in module
- Update link text to match actual document titles:
  - 'OVN-Kubernetes' → 'About the OVN-Kubernetes network plugin'
  - 'Compliance Operator' → 'Understanding the Compliance Operator'
- Move KVM limits link to Additional resources in assembly

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

fix conditional links

Fix AsciiDocDITA.AssemblyContents error by moving content to module

- Move OVN-Kubernetes, Compliance Operator, and Red Hat Ecosystem Catalog content from assembly to module
- Assembly should only contain abstract, includes, and Additional resources
- Fix ID to use {context} variable instead of hardcoded value
- Resolves AsciiDocDITA.AssemblyContents: 'Content other than additional resources cannot follow include directives'

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@abrennan89 abrennan89 force-pushed the virt-concept-about_virt branch from c83ece1 to eb96694 Compare May 15, 2026 18:09
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 15, 2026

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

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 CNV Label for all CNV PRs 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.

3 participants