Skip to content

🐛 fix broken JBoss EAP 6 messaging configuration link#376

Open
mvanhorn wants to merge 2 commits into
konveyor:mainfrom
mvanhorn:osc/344-fix-jboss-eap-broken-link
Open

🐛 fix broken JBoss EAP 6 messaging configuration link#376
mvanhorn wants to merge 2 commits into
konveyor:mainfrom
mvanhorn:osc/344-fix-jboss-eap-broken-link

Conversation

@mvanhorn

@mvanhorn mvanhorn commented May 6, 2026

Copy link
Copy Markdown

Summary

Resolves #344. The Messaging Configuration link in rule jboss-eap5-java-02000 (under stable/java/eap6/84-jboss-eap5-java.windup.yaml) returned a 404 after Red Hat migrated their documentation portal from access.redhat.com to docs.redhat.com. This swaps the URL to the working html-single version of the same guide.

Why this matters

The link is the primary remediation reference operators see when this rule fires during a Windup migration scan. A broken link strips the actionable context that makes the rule useful.

I verified the failure mode and the fix end-to-end:

$ curl -sIL 'https://access.redhat.com/.../JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-Configuration1.html'
HTTP/2 301 -> docs.redhat.com -> HTTP/2 404
$ curl -sIL 'https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/6.4/html-single/administration_and_configuration_guide/index#Configure_the_JMS_Server1'
HTTP/2 200

The Configure_the_JMS_Server1 anchor is preserved in the new page (grep against the rendered HTML returns id="sub-link-to-administration_and_configuration_guide-Configure_the_JMS_Server1"), so the deep-link still lands operators on the JMS Server configuration section.

Changes

  • stable/java/eap6/84-jboss-eap5-java.windup.yaml: update the JBoss EAP 6 - Messaging Configuration link to the new docs.redhat.com html-single URL.

Scope note

I deliberately limited the diff to the specific link the issue calls out. A grep -rln 'access.redhat.com/documentation/en-us/JBoss_Enterprise_Application_Platform/6.4' shows five rule files referencing the same domain pattern (stable/java/eap{6,7}/...); those probably need the same migration but treating that as a separate sweep keeps this PR focused on the issue's exact ask. Happy to do the bulk pass as a follow-up if the maintainers prefer.

Testing

  • python3 -c "import yaml; yaml.safe_load(open('stable/java/eap6/84-jboss-eap5-java.windup.yaml'))" — YAML still valid.
  • The new URL was pre-flighted with curl -sIL (200 OK + anchor present) before commit.

Fixes #344

Summary by CodeRabbit

  • Documentation
    • Updated many embedded documentation links across Java Windup rules and migration guides to point to the current Red Hat Docs site (docs.redhat.com), preserving original target topics/anchors (EAP, Hibernate, RESTEasy, WebLogic, WebSphere, Thorntail, Quarkus, MicroProfile, and related migration/configuration guides).

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 6, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cef989ea-9766-420e-9d5c-ed90e2b12eeb

📥 Commits

Reviewing files that changed from the base of the PR and between c3d7104 and 73c7e31.

📒 Files selected for processing (57)
  • stable/java/azure/08-eap-to-azure-appservice-datasource-driver.windup.yaml
  • stable/java/cloud-readiness/68-jca.windup.yaml
  • stable/java/cloud-readiness/74-session.windup.yaml
  • stable/java/eap6/80-seam-java.windup.yaml
  • stable/java/eap6/81-seam-ui.windup.yaml
  • stable/java/eap6/83-eap4-xml-config.windup.yaml
  • stable/java/eap6/84-jboss-eap5-java.windup.yaml
  • stable/java/eap6/85-jboss-eap5-xml.windup.yaml
  • stable/java/eap6/86-resteasy.windup.yaml
  • stable/java/eap6/88-jotm.rhamt.yaml
  • stable/java/eap6/95-environment-dependent.windup.yaml
  • stable/java/eap7/101-jaxrpc.windup.yaml
  • stable/java/eap7/102-jboss-eap5-7-java.windup.yaml
  • stable/java/eap7/103-jboss-eap5-7-xml.windup.yaml
  • stable/java/eap7/104-jboss-eap5and6to7-java.windup.yaml
  • stable/java/eap7/105-jboss-eap5and6to7-xml.windup.yaml
  • stable/java/eap7/106-resteasy.windup.yaml
  • stable/java/eap7/107-eap6-xml.windup.yaml
  • stable/java/eap7/108-eap6.windup.yaml
  • stable/java/eap7/109-hibernate4-xml.windup.yaml
  • stable/java/eap7/110-hibernate4.windup.yaml
  • stable/java/eap7/111-hsearch.windup.yaml
  • stable/java/eap7/113-resteasy.windup.yaml
  • stable/java/eap7/114-ws-security.windup.yaml
  • stable/java/eap7/115-hibernate50-51.windup.yaml
  • stable/java/eap7/116-hibernate51-53.windup.yaml
  • stable/java/eap7/117-picketlink25.windup.yaml
  • stable/java/eap7/118-resteasy30-36.windup.yaml
  • stable/java/eap7/119-deprecated-singletonpolicy.rhamt.yaml
  • stable/java/eap7/120-maven-artemis-jms-client.rhamt.yaml
  • stable/java/eap7/121-maven-javax-to-jakarta.rhamt.yaml
  • stable/java/eap7/123-move-to-microprofile-rest-client-1.3.rhamt.yaml
  • stable/java/eap7/125-microprofile_removed_from_eap.mta.yaml
  • stable/java/eap7/126-elytron.windup.yaml
  • stable/java/eap7/127-embedded-framework-libraries.windup.yaml
  • stable/java/eap7/130-weblogic-ejb.windup.yaml
  • stable/java/eap7/133-weblogic-services.windup.yaml
  • stable/java/eap7/135-weblogic-webservices.windup.yaml
  • stable/java/eap7/136-weblogic-xml-descriptors.windup.yaml
  • stable/java/eap7/137-weblogic.windup.yaml
  • stable/java/eap7/141-websphere-mq.windup.yaml
  • stable/java/eap7/142-websphere-mqe.windup.yaml
  • stable/java/eap7/143-websphere-other.windup.yaml
  • stable/java/eap7/144-websphere-xml.windup.yaml
  • stable/java/eap7/98-jboss-eap4and5to6and7-java.windup.yaml
  • stable/java/eap7/99-jboss-eap4and5to6and7-xml.windup.yaml
  • stable/java/eap8/171-login-modules.windup.yaml
  • stable/java/eap8/172-picketlink.windup.yaml
  • stable/java/eapxp/173-eapxp_bootable_jar_maven_plugin_configuration_changes.mta.yaml
  • stable/java/eapxp/176-remove_thorntail_yaml_configuration_files.mta.yaml
  • stable/java/eapxp/177-replace_thorntail_boms.mta.yaml
  • stable/java/eapxp/178-replace_thorntail_fractions.mta.yaml
  • stable/java/eapxp/179-replace_thorntail_maven_plugin.mta.yaml
  • stable/java/fuse-service-works/185-soa-p-5.windup.yaml
  • stable/java/hibernate/187-hibernate-xml.windup.yaml
  • stable/java/hibernate/188-hibernate.windup.yaml
  • stable/java/quarkus/216-javaee-pom-to-quarkus.windup.yaml
✅ Files skipped from review due to trivial changes (53)
  • stable/java/eap7/117-picketlink25.windup.yaml
  • stable/java/azure/08-eap-to-azure-appservice-datasource-driver.windup.yaml
  • stable/java/eap7/118-resteasy30-36.windup.yaml
  • stable/java/cloud-readiness/68-jca.windup.yaml
  • stable/java/eap6/95-environment-dependent.windup.yaml
  • stable/java/eap7/123-move-to-microprofile-rest-client-1.3.rhamt.yaml
  • stable/java/eap7/143-websphere-other.windup.yaml
  • stable/java/eapxp/176-remove_thorntail_yaml_configuration_files.mta.yaml
  • stable/java/eapxp/173-eapxp_bootable_jar_maven_plugin_configuration_changes.mta.yaml
  • stable/java/eap7/119-deprecated-singletonpolicy.rhamt.yaml
  • stable/java/eap6/86-resteasy.windup.yaml
  • stable/java/eap7/109-hibernate4-xml.windup.yaml
  • stable/java/eap7/120-maven-artemis-jms-client.rhamt.yaml
  • stable/java/eap7/106-resteasy.windup.yaml
  • stable/java/eap7/136-weblogic-xml-descriptors.windup.yaml
  • stable/java/eap7/126-elytron.windup.yaml
  • stable/java/eap7/107-eap6-xml.windup.yaml
  • stable/java/eap7/101-jaxrpc.windup.yaml
  • stable/java/eap7/115-hibernate50-51.windup.yaml
  • stable/java/eap7/114-ws-security.windup.yaml
  • stable/java/eap7/141-websphere-mq.windup.yaml
  • stable/java/eap8/172-picketlink.windup.yaml
  • stable/java/quarkus/216-javaee-pom-to-quarkus.windup.yaml
  • stable/java/eap7/142-websphere-mqe.windup.yaml
  • stable/java/eapxp/177-replace_thorntail_boms.mta.yaml
  • stable/java/eap7/135-weblogic-webservices.windup.yaml
  • stable/java/eap7/133-weblogic-services.windup.yaml
  • stable/java/eap7/98-jboss-eap4and5to6and7-java.windup.yaml
  • stable/java/eap7/104-jboss-eap5and6to7-java.windup.yaml
  • stable/java/eap7/108-eap6.windup.yaml
  • stable/java/eap6/88-jotm.rhamt.yaml
  • stable/java/eap7/137-weblogic.windup.yaml
  • stable/java/eap8/171-login-modules.windup.yaml
  • stable/java/hibernate/187-hibernate-xml.windup.yaml
  • stable/java/eap7/121-maven-javax-to-jakarta.rhamt.yaml
  • stable/java/eap7/103-jboss-eap5-7-xml.windup.yaml
  • stable/java/eap7/125-microprofile_removed_from_eap.mta.yaml
  • stable/java/cloud-readiness/74-session.windup.yaml
  • stable/java/eap7/130-weblogic-ejb.windup.yaml
  • stable/java/eap7/99-jboss-eap4and5to6and7-xml.windup.yaml
  • stable/java/eapxp/179-replace_thorntail_maven_plugin.mta.yaml
  • stable/java/eap7/127-embedded-framework-libraries.windup.yaml
  • stable/java/eap7/144-websphere-xml.windup.yaml
  • stable/java/eap6/81-seam-ui.windup.yaml
  • stable/java/eap7/102-jboss-eap5-7-java.windup.yaml
  • stable/java/eap6/80-seam-java.windup.yaml
  • stable/java/eap6/85-jboss-eap5-xml.windup.yaml
  • stable/java/fuse-service-works/185-soa-p-5.windup.yaml
  • stable/java/eap7/111-hsearch.windup.yaml
  • stable/java/eapxp/178-replace_thorntail_fractions.mta.yaml
  • stable/java/eap7/110-hibernate4.windup.yaml
  • stable/java/eap7/116-hibernate51-53.windup.yaml
  • stable/java/eap7/105-jboss-eap5and6to7-xml.windup.yaml

📝 Walkthrough

Walkthrough

Replaced legacy access.redhat.com documentation URLs with docs.redhat.com equivalents across many Windup/YAML rule files; only links[].url values changed and rule logic remained unchanged.

Changes

Documentation Link Updates

Layer / File(s) Summary
Replace access.redhat.com → docs.redhat.com in rule metadata
stable/java/*/*.{windup, rhamt, mta}.yaml
Rewrote links[].url values across multiple EAP, Hibernate, WebLogic, WebSphere, Fuse, Thorntail, Quarkus, Cloud/Azure, and other rule YAML files to point to docs.redhat.com anchors; no other YAML keys or rule logic were modified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A rabbit hops through YAML rows,
Fixing links where the old URL goes.
From access.redhat a broken track,
To docs.redhat it finds its back.
Hooray — the docs now lead the way!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: fixing a broken JBoss EAP 6 messaging configuration link by replacing it with a working URL.
Linked Issues check ✅ Passed The PR successfully addresses the objective from linked issue #344: replacing the broken access.redhat.com URL with a working docs.redhat.com html-single URL that preserves the Configure_the_JMS_Server1 anchor.
Out of Scope Changes check ✅ Passed The PR contains only the focused fix to the single broken link referenced in issue #344 (file 84-jboss-eap5-java.windup.yaml), with no out-of-scope changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Resolves konveyor#344. The Messaging Configuration link in rule jboss-eap5-java-02000
returned a 404 after Red Hat's documentation portal migrated from
`access.redhat.com` to `docs.redhat.com`.

Verified:
```
$ curl -sIL 'https://access.redhat.com/.../JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-Configuration1.html'
... HTTP/2 301 -> docs.redhat.com -> HTTP/2 404
```

The `html-single` (one-page) version of the same Administration and
Configuration Guide on the new portal returns 200 and preserves the
`#Configure_the_JMS_Server1` anchor:
```
$ curl -sIL 'https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/6.4/html-single/administration_and_configuration_guide/index#Configure_the_JMS_Server1'
... HTTP/2 200
```
And the anchor is present in the page source:
```
id="sub-link-to-administration_and_configuration_guide-Configure_the_JMS_Server1"
```

Scope is intentionally limited to the link in the issue. Other rule
files reference the same access.redhat.com path pattern; those can be
swept in a follow-up if the maintainers want a single bulk migration.

Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
@mvanhorn mvanhorn force-pushed the osc/344-fix-jboss-eap-broken-link branch from c3d7104 to b68ead4 Compare May 6, 2026 09:37
@jmle jmle self-requested a review May 11, 2026 07:27
@jmle

jmle commented May 11, 2026

Copy link
Copy Markdown
Contributor

Hey @mvanhorn , thanks for you contribution!

[...] those probably need the same migration but treating that as a separate sweep keeps this PR focused on the issue's exact ask. Happy to do the bulk pass as a follow-up if the maintainers prefer.

Please feel free to modify those too if they need to. This one looks good, but I'm going to put merging on hold in case you want to bulk it.

Bulk pass following the same pattern as the original JBoss EAP 6 messaging
fix in this PR. 172 access.redhat.com/documentation URLs across 57 files
were rewritten to docs.redhat.com using the verified pattern:

  access.redhat.com/documentation/en-us/<product>/<version>/{html,html-single}/<book>/...
  -> docs.redhat.com/en/documentation/<product_lowercase>/<version>/html-single/<book>/index<anchor>

70 URLs were skipped: /articles/ and /solutions/ paths don't have predictable
docs.redhat.com replacements, so they were left unchanged.

Per @jmle review comment on PR konveyor#376.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mvanhorn

Copy link
Copy Markdown
Author

Pushed 73c7e31 - bulk pass on the remaining documentation URLs. 172 access.redhat.com -> docs.redhat.com rewrites across 57 files, all under stable/, all using the same pattern as the original commit:

access.redhat.com/documentation/en-us/<product>/<version>/{html,html-single}/<book>/...
-> docs.redhat.com/en/documentation/<product_lowercase>/<version>/html-single/<book>/index<anchor>

70 URLs were left alone: /articles/ and /solutions/ paths don't have predictable docs.redhat.com replacements (Red Hat moves those into KCS articles with new IDs), so I'd rather skip than guess.

Couldn't run live HEAD verification on every URL - Red Hat's docs site returns 403 to bare curl regardless of host. The pattern matches the shape you confirmed in b68ead4 though. Happy to follow up on any specific URL if a downstream user reports one is still broken.

Ready for merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken link in jboss-eap5-java-02000

2 participants