Create a Release Note

Last modified by Vincent Massol on 2026/08/28 21:30

Steps

A release note gathers all the changes of one product version, as described in Release Notes.

  1. Open the Release Notes Application.
  2. Enter the product name and the version in the "Release Notes" form.

    add-release-note-form.png

  3. Click "Add Release Note".
  4. The release note is created from the configured template, with one section per audience and one for the credits.

    new-release-note.png

FAQ

Which version format should I use?

Use the product's own full version, such as 8.3-milestone-1; the page name is derived from it, so 8.3-milestone-1 becomes 8.3M1 and 8.3-rc-1 becomes 8.3RC1.

What happens if the release note already exists?

The form reports that the release note already exists and creates nothing, so an existing one is never overwritten.

Related

Get Connected