Vi jobber med å samle Skatteetatens api-dokumentasjon på en felles nettside.
Nettsiden lages basert på strukturen under /docs mappen på main-branch. Gjør endringer her for å endre informasjonen på nettsiden. Tjeneste-dokumenter må i tillegg legges inn i sidebars.js for at de skal vises.
Hvis dokumentasjon er under utarbeidelse eller api'et er i en beta-versjon og ikke skal være synlig i sidemenyen, kan man la være å legge det inn i listen over tjeneste-dokumenter i sidebars.js. Dokumentet vil da ikke dukke opp i sidemenyen.
For å publisere en nyhet, opprett en fil under nyheter-og-driftsvarsler.
Filnavnet burde inneholde dato samt kort beskrivelse, f.eks. 2022-02-25-13-05-problemer-med-tjenestene.md.
Innholdet i fila burde være på formen:
---
title: "Legg inn tittel på nyhet her"
tags: [news]
---
Legg inn nyhetstekst her.Nettsiden oppretter en ATOM-feed for nyhetene. tags i nyhetsfila mappes til category i feeden.
Driftsvarsler for API'ene ble lagt ut her før, men skal nå legges ut på status.skatteetaten.no. Derfor inneholder mappenavnet og adressen til feeden "driftsvarsler". Navnet beholdes for bakoverkompatibilitet.
Nettsiden bygges og deployes automatisk ved commit til main-branch.
This website is built using Docusaurus 2, a modern static website generator.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Dette repoet ble opprettet med utgangspunkt i https://github.com/Skatteetaten/datasamarbeid-api-dokumentasjon/tree/docusaurus