Wiki source code of Release Notes

Last modified by Vincent Massol on 2026/08/29 21:36

Hide last authors
Vincent Massol 3.1 1 The [[Release Notes Application>>doc:extensions:Extension.Release Notes Application.WebHome]] manages the release notes of a software product on a wiki: one page per product version, one child page per change it announces, and reports built from those changes.
2
Vincent Massol 6.1 3 The application renders a release note with its changes grouped by audience, so one set of changes serves users, administrators and developers at once. A final release also gathers the changes of its own milestones and release candidates, which means a milestone change is written once and reappears in the final release note. xwiki.org runs the application itself: its [[project release notes>>doc:xwiki:ReleaseNotes.WebHome]] are managed with it.
Vincent Massol 3.1 4
5 {{image reference="release-note-example.png" size="extra" alt="A release note page listing its changes under the For Users, For Admins and For Developers sections"/}}
6
7 Working with release notes:
8
9 * [[Access the Release Notes Application>>doc:documentation.extensions.user.release-notes.access-application.WebHome]] tells you where the application lives and what its home page offers.
10 * [[Create a Release Note>>doc:documentation.extensions.user.release-notes.create-release-note.WebHome]] starts a release note for a product version.
11 * [[Add a Change to a Release Note>>doc:documentation.extensions.user.release-notes.add-change.WebHome]] records what the release brings.
12 * [[Add Contributors to a Release Note>>doc:documentation.extensions.user.release-notes.add-contributors.WebHome]] credits the people behind it.
13 * [[Generate a Custom Change Report>>doc:documentation.extensions.user.release-notes.generate-report.WebHome]] queries the changes across products and versions.
14 * [[Change Displayers>>doc:documentation.extensions.user.release-notes.change-displayers.WebHome]] describes the four layouts a list of changes can be rendered with.

Get Connected