Fix broken internal xref links in reference docs - #37152
Conversation
There was a problem hiding this comment.
Good catches, and congratulations on submitting your first PR to the Spring Framework! 👍
Out of curiosity, how did you discover those broken links?
In any case, the build currently fails. So, please make sure you run the build locally (./gradlew antora) before submitting PRs or pushing commits to a PR.
In resttestclient.adoc, it looks like you'll need to include the filenames in addition to the anchors.
For example, xref:testing/resttestclient.adoc#resttestclient.workflow instead of just xref:resttestclient.workflow, and likewise for xref:resttestclient.assertj.
In addition, please base this PR on the 7.0.x branch, so that we can apply it there and forward merge to main. Feel free to "force push" your changes to this PR once you're done.
Cheers,
Sam
Signed-off-by: Gabriel Gerhardt <gabrielgerhardt27@gmail.com>
Signed-off-by: gabrielgerhardt <gabrielgerhardt27@gmail.com>
7a266c8 to
5b47c0f
Compare
|
Hi @sbrannen, Thanks for the review and the warm welcome! Regarding how I found them, I used an AI-assisted scan to compare every internal xref: link in the docs module against the anchors actually defined in their target files, then verified the mismatches by hand before fixing them. I've addressed all three points:
Let me know if anything else needs adjusting. |
👍
Thanks for sharing.
That looks better now. Thanks.
Yes, I added a request to rebase on
If you don't have time to do that, I can just manually merge the PR onto Let me know how you want to proceed. |
|
Just changed the base branch to 7.0.x as requested, so this should be ready to merge normally now whenever you get a chance. Thanks again for the review! |
|
Fixed via 507406c |
|
This has been merged into Thanks |
Several
xref:links inframework-docs/modules/ROOT/pagespoint at anchors that don't exist, most likely left over from the 2023 migration to Antora or later content reorganizations. All internalxref:links in the docs module were compared against the anchors actually defined in their target files; these are the ones that don't resolve.testing/resttestclient.adoc: three self-references used hyphenated ids (resttestclient-workflow/-assertj/-json) instead of the dotted ids the file actually defines (resttestclient.workflow/.assertj/.json).web/webflux/config.adocandweb/webmvc/mvc-config/content-negotiation.adocreferencedmvc-ann-requestmapping-suffix-pattern-match, which no longer exists — the section was renamed tomvc-ann-requestmapping-rfdwhen RFD coverage was added.content-negotiation.adochad both the stale and current link side by side, so the stale one was dropped.web/webmvc-test.adoclinked toweb-reactive.adoc#webflux-test, but that page defines no such anchor; the real target isweb/webflux-test.adoc.data-access/transaction/strategies.adocandcore/appendix/xml-custom.adocreferenced appendix anchors with the wrong prefix (missingappendix.in one place, an extracore.appendix.in six others).testing/testcontext-framework/ctx-management/groovy.adoclinked tocore/beans/basics.adoc#beans-factory-groovy, but that section now lives inlanguages/groovy.adoc.core/aop/schema.adoclinked to#aopinxsd-schemas.adoc, which defines the anchor asxsd-schemas-aop.Docs-only change, no functional code touched.