Flyttet til Direktoratet for e-helse
Testprosjekt for å se hvordan arkitekturdokumentasjon enklest mulig kan publiseres og vedlikeholdes på Github.
- Kjøre med peaceiris script og gh-pages build action
- Se på hvordan Mkdoc themes kan enkelt tilpasses https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
- Material
- Mangler nav bar footer?
- Mangler fargerike labels
- just the docs - layout template for Github.io sidene
- Oversette confluence sider til markdown
- index.md må ligge i rotkatalog på prosjektet?
- markdown filene bør ha just-the-docs metadata
---
layout: default
title: Innledning
nav_order: 1
---
-
Hvordan kjører vi versjoner (mike)
-
Prøvde dette scriptet for å bruke just the docs temaet med push til gh-branchen, men det feilet når Jekyll skulle startes
Just-the-docs kan bare eksistere i hovedkatalogen på gh-pages branchen på github.io, ellers brytes alle koblinger til bilder og andre sider (kanskje det eksisterer en innstilling?)- Mkdocs versjonen kan godt ligge under katalog (for eksempel "currentbuild") uten at lenker brytes
- Scriptet fungerer for produksjon av just-the-docs og deploy til gh-pages branch (root) Deploy Jekyll with JTD to gh-pages(root)
- Scriptet sletter gh-pages branchen i sin helhet før ny deploy
- Det er peaciris action som sletter også currentbranch katalogen
- Løsning, enten bruke opsjon for å beholde filer eller legge byggene i underkataloger, peaciris sletter bare gjeldende deploykatalog i destination_dir (men hvis dette er rotkatalogen (".") slettes hele gh-pages branchen)
Konfigurere baseurl og hostname for hvor dokumentasjonen skal ligge i _config.yml
baseurl: "/Malarkitektur-digital-hjemmeoppfolging/JTD-currentbuild" # the subpath of your site, e.g. /blog
url: "https://thomiz.github.io" # the base hostname & protocol for your site, e.g. http://example.com
Konfigurere deployscriptet tilsvarende (hvor peaciris legger produsert dokumentasjon).
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_site
destination_dir: ./JTD-currentbuild # Må stemme med baseurl: parameter i _config