Skip to content

Fix ConceptLink warnings in virt/backup_restore documentation#111742

Open
abrennan89 wants to merge 2 commits into
openshift:mainfrom
abrennan89:virt-concept-backup_restore
Open

Fix ConceptLink warnings in virt/backup_restore documentation#111742
abrennan89 wants to merge 2 commits into
openshift:mainfrom
abrennan89:virt-concept-backup_restore

Conversation

@abrennan89
Copy link
Copy Markdown
Contributor

Summary

This PR fixes AsciiDocDITA.ConceptLink warnings in the virt/backup_restore 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

Related

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

🤖 Generated with Claude Code

…ation

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>
@openshift-ci openshift-ci Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 15, 2026
@ocpdocs-previewbot
Copy link
Copy Markdown

ocpdocs-previewbot commented May 15, 2026

🤖 Fri May 15 18:06:38 - Prow CI generated the docs preview:
https://111742--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

- Remove old-style .Additional resources section inside conditional block
- Wrap platform-specific links in same conditionals as main content
- Fix ID to use {context} variable
- Remove blank line between heading and list
- Merge all Additional resources into single properly formatted section

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

Fixed conditional block handling in Additional resources section:

Issues found and fixed:

  1. ❌ Old-style .Additional resources section was inside a conditional block - removed
  2. ❌ Platform-specific links were not wrapped in conditionals - fixed
  3. ❌ Blank line between heading and list - removed
  4. ❌ Hardcoded context in ID - changed to use {context} variable

Applied new rule:
Links that appear inside conditional blocks in main content must also be inside the same conditional blocks in Additional resources. This ensures platform-specific content (OCP vs ROSA vs OSD) is properly scoped.

Result:

  • Merged old and new Additional resources sections into one properly formatted section
  • Platform-specific links now correctly wrapped in ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
  • All formatting follows documentation standards

Ready for review!

@openshift-ci openshift-ci Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 15, 2026
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 15, 2026

@abrennan89: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-portal c65f9d0 link true /test validate-portal

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

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.

2 participants