Skip to content

[#1153] Add OpenAM release notes - #1227

Open
vharseko wants to merge 1 commit into
OpenIdentityPlatform:masterfrom
vharseko:docs/1153-release-notes
Open

vharseko wants to merge 1 commit into
OpenIdentityPlatform:masterfrom
vharseko:docs/1153-release-notes

Conversation

@vharseko

@vharseko vharseko commented Nov 6, 2026

Copy link
Copy Markdown
Member

The guides refer readers to Release Notes, but that guide is missing. Add it using the OpenDJ documentation structure, register it in the documentation build, and link both installation 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.

Fixes #1153.

Validation

  • Ran doc-maven-plugin 3.2.2 preprocessing and Antora conversion using the configured documentation execution, and built the 12-page Release Notes PDF.
  • Built an Antora HTML preview and checked 45 local content links and anchors across the four new pages and two updated prefaces. Generated reference pages from the documentation-site checkout were included in the preview. 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.
  • Independently reviewed the changes and ran git diff --check.

Documentation-site follow-up

Publishing the generated modules and PDF must be accompanied by these additions to openam/antora.yml in OpenIdentityPlatform/doc.openidentityplatform.org, matching OpenDJ's registration:

     pdfs:
+      release-notes: https://github.com/OpenIdentityPlatform/OpenAM/wiki/asciidoc/pdf/Release_Notes.pdf
 ...
 nav:
+- modules/release-notes/nav.adoc

A local patch for these two additions was checked against the current site configuration. The live documentation site has not been changed.

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

Labels

documentation Documentation, README, or javadoc enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: add Release Notes

1 participant