Skip to content

DOCPLAN-364: Fix ConceptLink warnings in virt/support and included modules#111455

Merged
abrennan89 merged 1 commit intoopenshift:mainfrom
abrennan89:fix-concept-links-support
May 8, 2026
Merged

DOCPLAN-364: Fix ConceptLink warnings in virt/support and included modules#111455
abrennan89 merged 1 commit intoopenshift:mainfrom
abrennan89:fix-concept-links-support

Conversation

@abrennan89
Copy link
Copy Markdown
Contributor

@abrennan89 abrennan89 commented May 8, 2026

Move cross-references and links to Additional resources sections to resolve ConceptLink warnings in virt-collecting-virt-data.adoc and all module files included in virt/support assemblies.

Changes:

  • Moved 12 links/xrefs across 6 files (1 assembly + 5 modules)
  • Replaced links/xrefs with plain text in main content
  • Added links/xrefs to Additional resources sections
  • Preserved all empty lines and formatting

Link text improvements:

  • Used exact heading titles for xrefs (e.g., "Submitting a support case")
  • Capitalized and formatted external link text appropriately
  • Used gerund forms for procedure titles (e.g., "Modifying retention time...")
  • Matched link text to actual document section headings where possible

Files modified:

  • virt/support/virt-collecting-virt-data.adoc
  • modules/virt-collecting-data-about-your-environment.adoc (6 links)
  • modules/virt-collecting-data-about-vms.adoc (1 link)
  • modules/virt-generating-a-vm-memory-dump.adoc (1 link)
  • modules/virt-support-create-jira-issue.adoc (1 link)
  • modules/virt-support-submit-support-case.adoc (1 link)

Version(s):
4.20+

Issue:
https://redhat.atlassian.net/browse/DOCPLAN-364

Link to docs preview:

QE review:
n/a

@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 8, 2026
Comment thread modules/virt-collecting-data-about-vms.adoc Outdated
Comment thread modules/virt-collecting-data-about-vms.adoc Outdated
Comment thread modules/virt-collecting-data-about-your-environment.adoc Outdated
Comment thread modules/virt-collecting-data-about-your-environment.adoc Outdated
Comment thread modules/virt-generating-a-vm-memory-dump.adoc Outdated
Comment thread modules/virt-generating-a-vm-memory-dump.adoc Outdated
Comment thread modules/virt-support-create-jira-issue.adoc Outdated
Comment thread modules/virt-support-create-jira-issue.adoc Outdated
Move cross-references and links to Additional resources section in the
assembly file to resolve ConceptLink warnings. Links from included
modules are consolidated in the assembly's Additional resources section.

Changes:
- Moved 12 links/xrefs across 1 assembly and 5 modules
- Replaced links/xrefs with plain text in module content
- Added all links to assembly's Additional resources section
- Modules do NOT have Additional resources sections (only assemblies have them)
- Preserved all empty lines and formatting

Link text improvements:
- Used exact heading titles for xrefs (e.g., "Submitting a support case")
- Used gerund forms for procedures (e.g., "Modifying retention time...", "Configuring...")
- Proper capitalization and removed leading articles
- Matched URL fragments to actual heading titles where possible

Files modified:
- virt/support/virt-collecting-virt-data.adoc (added 12 links to Additional resources)
- modules/virt-collecting-data-about-your-environment.adoc (removed 6 links from prose)
- modules/virt-collecting-data-about-vms.adoc (removed 1 link from prose)
- modules/virt-generating-a-vm-memory-dump.adoc (removed 1 link from prose)
- modules/virt-support-create-jira-issue.adoc (removed 1 link from prose)
- modules/virt-support-submit-support-case.adoc (removed 1 link from prose)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@abrennan89 abrennan89 force-pushed the fix-concept-links-support branch from 9cac219 to 000e68d Compare May 8, 2026 18:16
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 8, 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.

@erpeters157
Copy link
Copy Markdown
Contributor

LGTM!

@abrennan89 abrennan89 merged commit 79c82d5 into openshift:main May 8, 2026
2 checks passed
@abrennan89
Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.20

@abrennan89
Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.21

@abrennan89
Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.22

@openshift-cherrypick-robot
Copy link
Copy Markdown

@abrennan89: #111455 failed to apply on top of branch "enterprise-4.20":

Applying: Fix ConceptLink warnings in virt/support
Using index info to reconstruct a base tree...
M	modules/virt-collecting-data-about-your-environment.adoc
M	virt/support/virt-collecting-virt-data.adoc
Falling back to patching base and 3-way merge...
Auto-merging virt/support/virt-collecting-virt-data.adoc
Auto-merging modules/virt-collecting-data-about-your-environment.adoc
CONFLICT (content): Merge conflict in modules/virt-collecting-data-about-your-environment.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Fix ConceptLink warnings in virt/support

Details

In response to this:

/cherrypick enterprise-4.20

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.

@openshift-cherrypick-robot
Copy link
Copy Markdown

@abrennan89: new pull request created: #111461

Details

In response to this:

/cherrypick enterprise-4.21

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.

@openshift-cherrypick-robot
Copy link
Copy Markdown

@abrennan89: new pull request created: #111462

Details

In response to this:

/cherrypick enterprise-4.22

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.

@abrennan89 abrennan89 changed the title Fix ConceptLink warnings in virt/support and included modules DOCPLAN-364: Fix ConceptLink warnings in virt/support and included modules May 8, 2026
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.

5 participants