Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 2.8 KB
Raw

los-dokumentasjno

Bidra

For å bidra til utviklingen av denne dokumentasjonen, må du clone den til din datamaskin og opprette en pull request.

Clone til din datamaskin

For at det følgende skal virke på din maskin, må du ha programvare installert:

Dersom du bruker Atom kan du gjøre som følger:

  • Trykk Ctrl+Shift+P
  • Skriv GitHub: Clone og trykk Enter
  • I Clone from legger du inn følgende url https://github.com/Informasjonsforvaltning/los-dokumentasjon.git

Alternativt i kommando-linje:

% git clone https://github.com/Informasjonsforvaltning/los-dokumentasjon.git
% cd los-dokumentasjon
% atom .                                # dersom du har installert Atom

Gjøre endringer

Denne standarden er laget i AsciiDoc med hjelp av verktøyet Asciidoctor.

Alle endringer må gjøres ved å endre eller legge til filer i docs-folderen. Se for eksempel på følgende veileder for god AsciiDoc praksis: https://asciidoctor.org/docs/asciidoc-recommended-practices

En typisk git-arbeidsflyt vil vere som følger:

% git checkout master
% git pull
% git checkout -b <ny branch>
% ... # gjør endringer i din valgte editor
% git add <filer som er endra>          # legger endringer klare for commit
% git commit -m "Fornuftig feilmeldng"  # utføre commit
% git push                              # publisere branch og gjøre klar for PR

Dersom du bruker Atom har du støtte for alt dette i Git-panelet.

Gå til https://github.com/Informasjonsforvaltning/los-dokumentasjon/pulls og opprett New pull request

Forhåndsvisning

Dersom du bruker Atom editor kan du installere pakken AsciiDoc Assistant Package. Du vil da få syntax-uthevelse og forhåndsvisning.

Generer html og pdf lokalt

For at det følgende skal virke på din maskin, må du ha programvare installert:

% cd docs
% docker run -it -v $(pwd):/documents asciidoctor/docker-asciidoctor
bash-5.1# asciidoctor -D . -o index.html main.adoc
bash-5.1# asciidoctor-pdf -D . -o files/los-dokumentasjon.pdf main.adoc
bash-5.1# asciidoctor-epub3 -D . -o files/los-dokumentasjon.epub main.adoc

Åpne filen index.html i din nettleser.

Teste html i en webserver på din maskin

Dersom du vil teste html på en server på din maskin, kan du feks installere Live Server For dette trenger du å installere Python på din datamaskin:

% python -m pip install --user live-server
% live-server docs

Åpne en nettleser og gå til http://localhost:8888