[#1154] Replace legacy ForgeRock relative links in the guides with Antora xrefs - #1158
Merged
vharseko merged 1 commit intoOct 1, 2026
Merged
Conversation
…n the guides with Antora xrefs - Point the docs/openam/13 and openam/13 links in the agent guides at the matching chapters and anchors of this documentation set - Point the openam-web-policy-agents / openam-jee-policy-agents links at the bundled Web and Java EE Policy Agent guides - Fix the "Configuring Policies" link in the Tomcat chapter, which pointed at the CDSSO chapter - Write the chap-jee-agent-config xrefs without the ./ prefix, which the Antora converter turned into an invalid module reference Fixes OpenIdentityPlatform#1154
maximthomas
approved these changes
Oct 1, 2026
maximthomas
left a comment
Contributor
There was a problem hiding this comment.
praise: Every legacy relative link in the guides now stays within this documentation set.
- No
link:../../and noxref:./remain underopenam-documentation/openam-doc-source/src/main/asciidocat the head. - The "Configuring Policies" link in
jee-users-guide/chap-apache-tomcat.adoc:31, which pointed at the CDSSO chapter, now targetsadmin-guide/chap-authz-policy.adoc#configure-policies-with-console.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1154
About 30 relative links in the guides pointed to the old ForgeRock documentation layout and resolve to 404 on https://doc.openidentityplatform.org. They now point at the matching pages of this documentation set.
Changes
link:../../../docs/openam/13/…andlink:../../../openam/13/…in the Web and Java EE agent guides → xrefs to the matching Administration / Installation Guide chapters and anchors. Two anchors no longer exist and are mapped to their closest current sections:wildcard-syntax→chap-authz-policy.adoc#policy-patterns-wildcardsconfigure-authz-policy/chap-authz-policy→chap-authz-policy.adoc#configure-policies-with-consolelink:../../../openam-web-policy-agents/…/link:../../../openam-jee-policy-agents/…→xref:../web-users-guide/index.adoc[…]/xref:../jee-users-guide/index.adoc[…]; the#configure-web-policy-agentlink goes toweb-users-guide/chap-web-agents.adoc.link:../../../openam/admin-guide/chap-cdsso→xref:../admin-guide/chap-cdsso.adoc#chap-cdsso[…]. Inchap-apache-tomcat.adocthe "Configuring Policies" link also pointed at the CDSSO chapter; it now points at the policy section.xref:./chap-jee-agent-config.adoc#…inchap-apache-tomcat.adocandchap-jetty.adoc→xref:chap-jee-agent-config.adoc#…: AntoraMojo turned the./form intoxref:.:chap-….The xrefs use the form already used across the guides,
xref:../<guide>/<chapter>.adoc#<id>[…], which AntoraMojo rewrites toxref:<guide>:<chapter>.adoc#<id>[…].window=\_blankis dropped from these links, since they now stay within the site, and the link texts follow the target headings.Verification
link:../../orxref:./links remain in the guide sources.mvn -P man-pages packageinopenam-doc-sourcesucceeds; the Antora output contains the rewritten links (e.g.xref:admin-guide:chap-cdsso.adoc#chap-cdsso[), all nine PDFs build, and asciidoctor reports no warnings.Not in scope: about 20
link:../<guide>/index.html#<anchor>links (dev-guide, reference, jee-users-guide) open the guide's index page on the site rather than the anchored section; they can be handled separately.