How to work with releasenotes in Developer portal

This document describes how to work with releasenotes in the repository. Short story is that you can have a file named releasenotes.json under the docs catalog which then will automatically be rendered on Developer portal. Note that you also can add it backoffice.

Retrieving the json of the existing releasenote

Some has existing releasenotes already made in the Developer portal CMS. To ease the transition, an endpoint have been made so that ready make json can be extracted. Then it can be copied into a releasenote.json file, and it will be much easier gettting started 👍

Do the following to extract the json

• Login to the backoffice for the Developer portal (https://utviklerportal.nhn.no/umbraco)
• Find the ID for the releasenote. It is located on the "Info" tab and is four digits
• Use the API endpoint GetReleasenotes to extract: (https://utviklerportal.nhn.no/swagger/index.html). The easiest is to use the "Try it out" function.

The releasenote.json file

Below an example of what this file can look like:

{
  "headline": "Release Notes - Utviklerportal",
  "introText": null,
  "majorVersions": [
    {
      "title": "Version 5",
      "minorVersions": [
        {
          "title": "5.0 - Umbraco 12",
          "releaseDate": "2023-11-28T00:00:00",
          "status": "prod",
          "description": "Description of the version"
        }
      ]
    },
  ]
}

Most of the fields are self-explanitory. The json file can have multiple majorVersions and each majorVersion can have multiple minorVersions.

Placement of the releasenotes.json file.

The releasenotes.json must be placed directly under the /docs catalogue. Currently that is the only supported location for this file.