Release Notes
Explanation
The Release Notes Application 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.
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 are managed with it.
Working with release notes:
- Access the Release Notes Application tells you where the application lives and what its home page offers.
- Create a Release Note starts a release note for a product version.
- Add a Change to a Release Note records what the release brings.
- Add Contributors to a Release Note credits the people behind it.
- Generate a Custom Change Report queries the changes across products and versions.
- Change Displayers describes the four layouts a list of changes can be rendered with.
FAQ
Why is a change listed under Miscellaneous?
User and administrator changes that carry no screenshot are gathered there, and so are developer changes whose importance is Low.
Why can I no longer add changes to a release note?
The "Add ... Change" buttons disappear once the release note's "Released" property is ticked, so a published release note cannot be extended by accident.
More
To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.
