Repository navigation
Conversation
vharseko
added
documentation
vharseko
added a commit
to OpenIdentityPlatform/OpenAM
that referenced
this pull request
Nov 7, 2026
The installation and Java EE agent guides refer readers to Release Notes, but that guide is missing. Add a four-page guide using the OpenDJ documentation structure, register it in the documentation build, and link both prefaces. The guide includes selected changes and all eight distribution assets for 16.1.4, Java/container requirements, upgrade considerations, 18 published security advisories fixed in 16.1.4, and a brief history of all 69 published community releases. Release records and source comparisons remain linked for full details. All 35 source-comparison URLs preserve GitHub's literal three-dot separator in both HTML and PDF. The upgrade guidance identifies the IdP discovery return-URL allowlist, its format, and how to configure it for both OpenAM-hosted endpoints and a standalone IDP Discovery WAR. The 16.1.2 security-advisory reminder applies to the server generally and appears before the standalone-WAR instructions. Links between chapters resolve within the combined PDF, and each redirect advisory has a short description, including the goto/gotoOnFail cross-site scripting issue. Fixes #1153. ## Validation - Ran doc-maven-plugin 3.2.2 preprocessing, Antora conversion, and PDF generation, including the plugin's PDF preprocessing step. Rebuilt the 12-page Release Notes PDF with Asciidoctor PDF 2.3.18. - Verified that all 35 distinct comparison URLs match the original source URLs exactly in the generated Antora HTML hrefs and PDF URI annotations, without a substituted ellipsis, zero-width space, or escape character. An Asciidoctor.js 2.2.9 before/after check reproduced all 35 failures before the fix and confirmed all 35 exact URLs after it. - Checked the PDF chapter-link destinations and confirmed that the security-advisory reminder precedes the standalone-WAR paragraph in the rendered output. - Built an Antora HTML preview and checked 46 local content links and anchors across the four new pages and two updated prefaces. Generated reference pages from the documentation-site checkout were included. No diagnostics came from the new guide; nine existing attribute warnings remain in other pages. - Checked all 69 release records and UTC dates, all eight asset names, and the 18 advisories' published status and patched versions against GitHub. Checked platform and compatibility claims against tagged sources and history, including IdP discovery configuration in 16.1.2. - Ran `git diff --check`. ## Documentation-site follow-up The companion registration is in [doc.openidentityplatform.org#44](OpenIdentityPlatform/doc.openidentityplatform.org#44). It adds the Release Notes sidebar entry and PDF download mapping to `openam/antora.yml`. Merge and deploy this PR first, including the generated `openam/modules/release-notes` module and `Release_Notes.pdf`; merge the site registration after those artifacts are available.
This branch has not been deployed
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.
Register the OpenAM Release Notes guide in the documentation sidebar and expose its PDF download, following the existing OpenDJ configuration.
Companion to OpenIdentityPlatform/OpenAM#1227.
Fixes OpenIdentityPlatform/OpenAM#1153.
Deployment order
Merge and deploy OpenIdentityPlatform/OpenAM#1227 first, including the generated
openam/modules/release-notesmodule andRelease_Notes.pdf. Merge this registration after those artifacts are available. The current site content does not yet contain the guide.Validation
git diff --check.