Hvordan jobbe med brukermanualen
Brukermanualen er bygget fra "Main" branchen til Github pages. Byggingen skjer automatisk etter at en fil i branchen har blitt "Committed". For å se selve manualen og den siste "offisielle" utgaven er manualen tilgjengelig på https://docs.puzzlepart.com/prosjektportalen-manual/. Det er disse sidene (og ikke filene i repository) som Prosjektportalen benytter som sitt hjelpeinnhold.
Byggeprosessen skjer automatisk ved hjelp av Github Actions. For mer informasjon om denne henvises det til https://github.com/Puzzlepart/prosjektportalen-manual/actions.
Siden det som endres vil bli bygget automatisk og publisert uten ugrunnet opphold er det ikke mulig å "forberede" en endring som skal publiseres på et senere tidspunkt herfra. Derfor benyttes et eget repository på Github ved utarbeidelsen av endringer.
Dette repository finner du her: https://github.com/Puzzlepart/prosjektportalen-manual-kladd.
Også dette repository bygges med Actions og vil automatisk publiseres på denne adressen: https://docs.puzzlepart.com/prosjektportalen-manual-kladd/.
Det er i hovedsak to fremgangsmåter
- Bruke nettleser
- Bruke git og Visual Studio Code eller en annen markdown formatter
Naviger til innholdet under "Code". I mappestrukturen vil man finne sidene som kan oppdateres. For brukermanualen er det i all hovedsak innholdet under folderstrukturen "Brukermanual" som benyttes. På hver side kan man trykke "Edit" gjennom blyanten. Pass på at alle endringer som gjøres direkte i "Main" branchen (merket med rødt her)
Etter at man har gått inn i Edtit modus ved å trykke på blyanten kan man jobbe med innholdet.
Hopp mellom Edit og Preview (markert) for å se hvordan endringen blir.
For at bilder skal bli håndtert riktig er det viktig at disse lastes opp på riktig måte. Prosjektportalen har ikke funksjonalitet for å vise bilder med absolutt referanse, og bilder må derfor ligge på sidene med relativ referanse for at Prosjektportalen viser bilde riktig.
Når endringene er gjort, trykk på Commit via den store grønne knappen. Angi deretter en beskrivelse og commit.
.
Installer git. Installer VS Code. Klon prosjektet. Det jobbes rett på Main-branchen.