Hvordan jobbe med roadmap i Utviklerportalen

Dette dokumentet beskriver hvordan du håndterer roadmap i repositoryet. Kort oppsummert kan du ha en fil som heter roadmap.json under docs‑katalogen, og den vil automatisk bli rendret i Utviklerportalen. Merk at du også kan legge den til via backoffice (her).

Hente JSON for eksisterende roadmap

Noen har allerede opprettet en roadmap i Utviklerportal‑CMS. For å lette overgangen er det laget et API‑endpoint som gjør at du kan trekke ut JSON‑en. Deretter kan du kopiere den inn i en roadmap.json‑fil, og du får et mye enklere oppsett 👍

Gjør følgende for å eksportere JSON‑en:

• Logg inn i backoffice for Utviklerportalen (https://utviklerportal.nhn.no/umbraco)
• Finn ID‑en til roadmapen. Den finnes på fanen «Info» og består av fire sifre.
• Bruk API‑endpointet GetRoadmap for å hente den: (https://utviklerportal.nhn.no/swagger/index.html). Den enkleste måten er å bruke «Try it out»‑funksjonen.

roadmap.json‑filen

Nedenfor er et eksempel på hvordan denne filen kan se ut:

{
  "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
    }
  ]
}

De fleste feltene er selvforklarende. JSON‑filen kan ha flere releaseGroupNow, releaseGroupNext og releaseGroupLater.

Hvor roadmap.json‑filen skal plasseres

roadmap.json‑filen må plasseres direkte i /docs‑katalogen. Dette er foreløpig den eneste støttede plasseringen for filen.