Gå til hovedinnhold

FS Utgivelsesnotater-system

Et enkelt, utviklervennlig system for å håndtere og vise produktendringer.

📁 Mappestruktur​

src/pages/changelog/
├── README.md                    # Denne filen
├── TEMPLATE.mdx                # Mal for nye oppføringer
├── entries
│  └──── 2025-08-27-funksjons-navn.mdx # Faktiske oppføringer
└── ...

🚀 Kom i gang​

Opprette en ny oppføring​

  1. Lag et nytt utgivelsesnotatet innslag For å ta utgangspunkt i malen våres kjør kommandoen under:

    cp src/pages/changelog/TEMPLATE.mdx src/pages/changelog/entries/{FYLL_INN_NAVN_HER}.mdx

  2. Rediger filen med dine endringer. Les dokumentasjon under for informasjon om hvordan utgivelsesnotatet bør skrives.

  3. Test det lokalt

  4. Lag MR for å få det lagt inn

📝 Oppføringsformat​

Hver utgivelsesnotat-oppføring er en .mdx-fil med YAML frontmatter:

---
title: "Kort, tydelig beskrivelse"
date: 2025-08-27
type: new | changed | fixed | deprecated | security
area: ["API", "UI"]
audience: ["Utvikler", "Student"]  # Valgfritt
impact: "Low" | "Medium" | "High"   # Valgfritt
version: "v2.1.0"                   # Valgfritt
breaking: true | false              # Valgfritt
tags: ["backend", "auth"]           # Valgfritt
links:
  - { text: "Dokumentasjon", url: "/docs/..." }
  - { text: "GitLab MR !123", url: "https://..." }
summary: >
  Kort beskrivelse av endringen i 2-3 setninger.
  Brukervennlig språk, unngå teknisk sjargong.
---

# Valgfritt detaljert innhold kommer her

🏷️ Feltreferanse​

Påkrevde felt​

  • title: Klar, kortfattet beskrivelse av endringen
  • date: ISO-format (YYYY-MM-DD)
  • type: En av new, changed, fixed, deprecated, security
  • area: Array med 1-3 påvirkede områder (f.eks. "API", "UI", "Database")
  • summary: 2-3 setninger beskrivelse på brukervennlig språk
  • links: Minst én lenke til dokumentasjon, MR eller sak

Valgfrie felt​

  • audience: Hvem dette påvirker (["Utvikler", "Student", "Ansatt", "Admin", "Offentlig"])
  • impact: Alvorlighetsgrad ("Low", "Medium", "High")
  • version: Versjonsnummer hvis del av en utgivelse
  • breaking: Sett til true hvis dette er en kompatibilitetsbrytende endring
  • tags: Ytterligere kategoriseringstagger

📊 Visningsfunksjoner​

Utgivelsesnotater-systemet inkluderer:

  • Filtrering: Etter type, område, påvirkning, målgruppe, kompatibilitetsbrytende endringer
  • Søk: Fulltekstsøk på tvers av titler, sammendrag og tagger
  • Sortering: Nyeste oppføringer først
  • Responsivt design: Fungerer på alle skjermstørrelser

📋 Beste praksis​

Skrive gode oppføringer​

  1. Brukerfokusert språk: Skriv for din målgruppe, ikke bare utviklere
  2. Vær spesifikk: "Fikset innloggingstimeout" vs "Fikset feil"
  3. Inkluder påvirkning: Nevn hvem som påvirkes og hvordan
  4. Gi lenker: Link alltid til relevant dokumentasjon eller saker
  5. Bruk eksempler: Kodeeksempler eller skjermbilder hjelper forståelsen

Frontmatter-retningslinjer​

  • Datoer: Bruk faktisk utgivelses-/distribusjonsdato, ikke når du skriver oppføringen
  • Områder: Begrens til 2-3 mest relevante områder for å unngå overkategorisering
  • Sammendrag: Hold det samtaleaktig men informativt
  • Kompatibilitetsbrytende endringer: Sett alltid breaking: true og forklar påvirkningen

Filnavngiving​

Bruk formatet: YYYY-MM-DD-kort-beskrivelse.mdx

  • Dato bør matche frontmatter-datoen
  • Beskrivelse bør være kebab-case (små bokstaver med bindestreker)
  • Hold det kortfattet men beskrivende