How to work with roadmap in Developer portal

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

Retrieving the json of the existing releasenote

Some has existing roadmap 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 GetRoadmap to extract: (https://utviklerportal.nhn.no/swagger/index.html). The easiest is to use the "Try it out" function.

The roadmap.json file

Below an example of what this file can look like:

{
  "headline": "Roadmap",
  "introText": "Some introtext",
  "descriptionNow": "What you are working on now",
  "descriptionNext": "What you are working on next.",
  "descriptionLater": "What you are working on at a later stage.",
  "releaseGroupNow": [
    {
      "title": "Title now",
      "description": "Description now.",
      "targetReleaseDate": "Q1 2024"
    }
  ],
  "releaseGroupNext": [
    {
      "title": "Title next",
      "description": "Description next.",
      "targetReleaseDate": "Q2 2024"
    },
  ],
  "releaseGroupLater": [
    {
      "title": "Title later",
      "description": "Description later",
      "targetReleaseDate": null
    }
  ]
}

Most of the fields are self-explanitory. The json file can have multiple releaseGroupNow, releaseGroupNext and releaseGroupLater.

Placement of the roadmap.json file

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