Vi er i gang med å forbedre Brønnøysundregistrenes dokumentasjon og gjøre den enkel å vedlikeholde.
- 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.
- Pull eksisterende endringer.
- Gjør endringene du ønsker på din lokale kopi, helst direkte på
masterbranch. - 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 athugokan være sperret av gruppepolicy, og da må kan man måtte bruke kommandolinje startet med administratortilgang for å kjøre programmet. - 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 - Deploy endringene ved å committe endringer og pushe til
master
- Sortering av undersider i venstremenyen styres ved bruk av metadatafeltet
weightpå 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.
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.