Release Notes

About the Release Notes template

The Release Notes template is there to give you an easy and stylized way of visualizing your release notes and / or changelog. The template will list out your major and minor versions vertically, with minor versions being clickable, opening up a panel that contains all of your notes for that version.

The release notes template.

The on-click details panel.

Currently, release notes are available for all backoffice editors, but we are working on a way to also enable developers to add release notes to their documentation through HelseGitLab / Milliways using .json files to be synced into the developer portal like any other markdown file or image.

Inputs

In terms of inputs, the release notes template will ask for some descriptive text inputs to begin with. A simple headline and intro text could give your users a quick overview of what to expect, but these are optional. You will find these inputs in the first tab when you open a Release Notes content node.

The meat of this template however lies in the "versions" input. Just like with components, this is a list of major versions that you can add, drag to sort and delete at your leisure. Each major version has inputs for title and minor versions. Minor versions function just like major versions. Add, drag to sort, delete. So you will have a list of major versions, each major version contains a list of minor versions.

The minor version has inputs for title, release date, status and details. The status switch is basically a selection of test and production, whichever suits your current status.

The final result will be what you saw in the first image above.

And that just about covers it, as with every other content node you create you will also find input tabs for listing settings as well as SEO and sharing, so feel free to add some content here as well!

As an editor you might also be interested in the Roadmap template. If however you wish to deep-dive into the documentation page and its functions you should take a look the "developers" section of our documentation.

Note that you can also create and maintain releasenotes from the repository.