Skip to content

brreg/docs

Repository files navigation

Brønnøysundregistrene dokumentasjon

Vi er i gang med å forbedre Brønnøysundregistrenes dokumentasjon og gjøre den enkel å vedlikeholde.

Getting started

  • Skaff tilgang til en github bruker tilkoblet din brsys-mail og clone deretter dette docs-repoet
  • Last ned hugo, se her for instruksjoner: Nedlasting av Hugo. Filer for nedlasting er tilgjengelige på Hugos releases GitHub. Om du bruker vanlig Windows så kan du velge releasen med navn som slutter på windows-amd64.zip. Pass på at du laster ned versjonen som brukes i applikasjonen.
  • Pakk ut filen og legg den i rotmappen på docs-repoet. Ved innsjekk av endringer vil git overse Hugo-filen (.gitignore) slik at den ikke lastes opp.

Ønsker du å bidra?

  1. Pull eksisterende endringer.
  2. Gjør endringene du ønsker på din lokale kopi, helst direkte på master branch.
  3. Inspiser at resultatet er slik du ønsker, f.eks vha hugo server. Dette starter en lokal webserver som kan nås via default adresse localhost:1313/docs. Merk at hugo kan være sperret av gruppepolicy, og da må kan man måtte bruke kommandolinje startet med administratortilgang for å kjøre programmet.
  4. Dersom du har gjort større endringer, f.eks. fjernet eller lagt til sider med tekst, kan det lønne seg å bygge en ny indeks for søkefeltet som tilbys på websiden ved å kjøre følgende (krever NodeJS installert): node build-lunr-index.js
  5. Deploy endringene ved å committe endringer og pushe til master

Tips og triks

  • Sortering av undersider i venstremenyen styres ved bruk av metadatafeltet weight på de enkelte undersidene. Høyere tallverdi gjør at sidene synker i sorteringen.

Du kan også foreslå forbedringer eller påpeke bugs ved å opprette en issue.

Oppsettet av dokumentasjonsrepoet

Hugo genererer med kommandoen hugo et sett med statiske dokumentasjonsfiler i mappen public. Ved pushing til master vil en GitHub Workflow automatisk kjøre hugo og legge genererte html-filer i branchen gh-pages. Oppdaterte html-filer blir automatisk tilgjengelige i løpet av få strakser på BRDocs, vår GitHub Site for dokumentasjon. På github finnes det under Deployments automatisk deploy av endringer pushet til gh-pages.