Configure the Release Notes Application

Last modified by Vincent Massol on 2026/09/02 20:05

Steps

The configuration holds the defaults that new release notes are created with, as described in Release Notes.

  1. Release Notes Application 2.4+ Open the wiki administration and click "Other", then "Release Notes".

    The Release Notes section of the wiki administration, reached from the Other category

  2. Set "Template Reference" to the page new release notes are copied from, and "Default Product Name" to the product the wiki documents.

    The Template Reference and Default Product Name fields with their hints

  3. Click "Save".
  4. The creation form on the application home page is now pre-filled with the product you set.

    The release note creation form pre-filled with the configured default product name

FAQ

Where are the two values stored?

In a ReleaseNotesConfigClass object on the ReleaseNotes.Code.ReleaseNotesConfig page, which is what the administration section edits.

The wiki documents several products. What should I set?

Leave "Default Product Name" empty, which is how the application ships, so that the creation form starts blank and you name the product each time.

Does changing the default product affect existing release notes?

No. It only pre-fills the creation form, so release notes already created keep the product they were created with.

Will an upgrade of the extension overwrite my configuration?

No. An upgrade merges the shipped configuration page with yours, so the template reference and the product name you set are kept.

Related

Get Connected