difi/begrep-jekyll repository overview

h3. Kort om katalogen

Begrepskatalogen skildrer alle begrep benyttet i implementasjonen av Sikker Digital Post. Katalogen definerer begrep ved å gi dem en unik adresse (URI), versjon og egenskapar (attributter).

Alle tjenester som benytter eller utveksler informasjon med Sikker Digital Post skal annotere (referere til) disse begrepene i sine implementasjonar (både teknisk gjennom standarder som "SA-WSDL":http://www.w3.org/2002/ws/sawsdl/⁠ og som hyperlenker i dokumentasjon).

Målet er å sikre semantisk interoperabilitet på tvers av tjenestene (alle snakkar om det same).

h3. Hvor er katalogen?

Den offisielle versjonen av katalogen ligger på nettsider "begrep.difi.no":http://begrep.difi.no⁠

h3. Hvordan bidra til katalogen

Kilden til katalogen er versjonskontrolert og gjort tilgjengelig på "Difi sitt Github.com":https://github.com/difi⁠ område. Github vil til en hver tid inneholde siste versjon av katalogen.

Filene er skrevet med "Textile formatering":http://en.wikipedia.org/wiki/Textile_(markup_language)⁠ og tilrettelagt for internett ved hjelp av "Jekyll":http://jekyllrb.com/⁠.

For å kunne bidra må du først installere git lokalt. Du finner mer informasjon om hvordan på hjelpesidene til Github "https://help.github.com/articles/set-up-git":https://help.github.com/articles/set-up-git⁠

På sikt vil det ikke bli godtatt endringar gjort i katalogen som ikke på en eller annen måte refererer til en "issue på github":https://help.github.com/articles/closing-issues-via-commit-messages⁠ . Poenget med dette er å ha full sporing på hvorfor en bestemt endring har blitt gjort.

h3. Lokalt miljø for Jekyll

Begrepskatalogen benytter et "Vagrant":http://vagrantup.com⁠ script til å bygge opp en "Virtualbox":http://virtualbox.org⁠ boks med et lokalt utviklingsmiljø. Etter at vagrant har startet boksen får man tilgang til begrepskatalogen lokalt ved å benytte "http://localhost:4080":http://localhost:4080⁠

Alle endringer gjort i filene blir automatisk oppdatert.