Table of Contents

IDMS Support Page - Release Notes

Author: Michelle McCausland

Release Notes - Background

Release notes are created to accompany each development sprint. They denote the tickets worked on as part of each sprint and include a concise description of the general updates made.

Each customer will receive their own version of the release notes including their customer specific tickets as well as general Errigal items.

Release notes are deployed to the Support Page during a release. More information on the Support Page can be found on the IDMS Support Page section of this wiki.

Note: since IDMS 3.14 (Oct 2020) it is possible to automate the deployment of release notes etc. via Jenkins. More detail on this process can be found here: Updating & Deploying User Guides

Manually Uploading Release Notes

The steps involved with manually uploading a new release notes file to the support page are as follows:

  1. Navigate to the Support Page Dashboard by selecting the Dashboard button from the header menu on the Support Page.
  2. Note: you must have admin privileges to do so, this is tied to the admin tole. There is an IDMS ticket to make this more configurable.
  3. Once on the dashboard, select the Manage Files controller to upload the PDF release notes file.
  4. From here select Add New File and add the PDF file, naming it accordingly: Release Notes - IDMS 3.12
  5. Now that the file itself has been uploaded you must make sure there is a corresponding entry for the release notes in the Manage Release Notes controller.
  6. Select the Manage Release Notes Controller.
  7. To create a new Release Notes entry, select new ReleaseNotes and enter an appropriate name e.g. Release Notes - IDMS 3.12 before selecting the PDF file you uploaded.
  8. Verify the changes have been successful by reviewing the release notes on the front end.

Note: It's good practice to remove old and unused files from the UploadableFile controller after new release notes have been loaded. Simply go into each file and select Delete to remove them. Any files that are associated with User Guides or Release Notes etc. will be linked and will not be allowed to be deleted.