Use headings not list for TL;DR (#23)

* Write TL;DR section 'Kvalitet' * Use hyphen Co-authored-by: John Kasper Svergja <[email protected]> * Format with headings * Re-write shift-left TL;DR * Include examples of code formatting tools * Use headings not list for TL;DR --------- Co-authored-by: John Kasper Svergja <[email protected]>
statisticsnorway · Dec 21, 2023 · 470828f · 470828f
1 parent 1a8f3a1
commit 470828f
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 35 deletions.
diff --git a/dapla-manual/utviklere/tldr/ci-cd.qmd b/dapla-manual/utviklere/tldr/ci-cd.qmd
@@ -1,9 +1,9 @@
 ---
+title: CI/CD
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
 
-# CI/CD
-
-- [MÅ]{.must} anvende GitHub Actions som CI/CD verktøy.
+## [MÅ]{.must} anvende GitHub Actions som CI/CD verktøy.
diff --git a/dapla-manual/utviklere/tldr/dokumentasjon.qmd b/dapla-manual/utviklere/tldr/dokumentasjon.qmd
@@ -1,7 +1,8 @@
 ---
+title: Dokumentasjon
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
 
-# Dokumentasjon
diff --git a/dapla-manual/utviklere/tldr/infrastruktur.qmd b/dapla-manual/utviklere/tldr/infrastruktur.qmd
@@ -1,7 +1,7 @@
 ---
+title: Infrastruktur
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
-
-# Infrastruktur
diff --git a/dapla-manual/utviklere/tldr/kjoeremiljoe.qmd b/dapla-manual/utviklere/tldr/kjoeremiljoe.qmd
@@ -1,10 +1,10 @@
 ---
+title: Kjøremiljø
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
 
-# Kjøremiljø
-
-- [BØR]{.should} kjøre tjenester på NAIS.
-- [MÅ]{.must} bruke en Service Account for autentisering fra en tjeneste.
+## [BØR]{.should} kjøre tjenester på NAIS.
+## [MÅ]{.must} bruke en Service Account for autentisering fra en tjeneste.
diff --git a/dapla-manual/utviklere/tldr/kultur.qmd b/dapla-manual/utviklere/tldr/kultur.qmd
@@ -1,7 +1,7 @@
 ---
+title: Kultur
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
-
-# Kultur
diff --git a/dapla-manual/utviklere/tldr/overvaakning.qmd b/dapla-manual/utviklere/tldr/overvaakning.qmd
@@ -1,12 +1,12 @@
 ---
+title: Overvåkning
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
 
-# Overvåkning
-
-- [MÅ]{.must} eksponere readiness og liveness-endepunkter fra langtlevenede tjenester.
-- [MÅ]{.must} eksponere metrikk/admin/service-endepunkter på egne porter.
-- [BØR]{.should} strukturere logger i JSON-format.
-- [BØR]{.should} skrive logger til stdout.
+## [MÅ]{.must} eksponere readiness og liveness-endepunkter fra langtlevenede tjenester.
+## [MÅ]{.must} eksponere metrikk/admin/service-endepunkter på egne porter.
+## [BØR]{.should} strukturere logger i JSON-format.
+## [BØR]{.should} skrive logger til stdout.
diff --git a/dapla-manual/utviklere/tldr/tldr.qmd b/dapla-manual/utviklere/tldr/tldr.qmd
@@ -12,17 +12,17 @@ Her finnes det ikke lange beskrivelser, bare *akkurat det du trenger å vite som
 
 Hver TL;DR:
 
-- [MÅ]{.must} begynne med et av ordene beskrevet i [Begrepsforklaring](#begrepsforklaring).
-- [MÅ]{.must} være på norsk.
-- [MÅ]{.must} være en leselig setning.
-- [BØR]{.should} være mulig å iverksette i ethver utviklers arbeid.
-- [KAN]{.may} lenke til mer utfyllende informasjon.
+#### [MÅ]{.must} begynne med et av ordene beskrevet i [Begrepsforklaring](#begrepsforklaring).
+#### [MÅ]{.must} være på norsk.
+#### [MÅ]{.must} være en leselig setning.
+#### [BØR]{.should} være mulig å iverksette i ethver utviklers arbeid.
+#### [KAN]{.may} lenke til mer utfyllende informasjon.
 
 ## Begrepsforklaring
 
 Betydningen defineres av [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt), med tilhørende oversettelse til norsk.
 
-- [MÅ (IKKE)]{.must}
-- [BØR (IKKE)]{.should}
-- [KAN]{.may}
+#### [MÅ (IKKE)]{.must}
+#### [BØR (IKKE)]{.should}
+#### [KAN]{.may}
 
diff --git a/dapla-manual/utviklere/tldr/utvikling.qmd b/dapla-manual/utviklere/tldr/utvikling.qmd
@@ -1,7 +1,7 @@
 ---
+title: Utvikling
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
-
-# Utvikling
diff --git a/dapla-manual/utviklere/tldr/versjonskontroll.qmd b/dapla-manual/utviklere/tldr/versjonskontroll.qmd
@@ -1,13 +1,13 @@
 ---
+title: Versjonskontroll
 format:
     html:
         css: tldr.css
+        toc-location: body
 ---
 
-# Versjonskontroll
-
-- [MÅ]{.must} legge alt av kildekode under versjonskontroll.
-- [MÅ]{.must} følge [SSBs retningslinjer](https://statistics-norway.atlassian.net/wiki/x/BQBXu) når nye repoer opprettes.
-- [MÅ]{.must} følge [SSBs retningslinjer](https://adr.ssb.no/0006-aapen-kildekode-i-ssb/) for åpenkildekode.
-- [MÅ]{.must} anvende [Feature Branch](https://martinfowler.com/bliki/FeatureBranch.html) mønster.
-- [MÅ]{.must} unngå å legge [hemmeligheter](https://statistics-norway.atlassian.net/wiki/x/JIDZyQ) under versjonskontroll.
+## [MÅ]{.must} legge alt av kildekode under versjonskontroll.
+## [MÅ]{.must} følge [SSBs retningslinjer](https://statistics-norway.atlassian.net/wiki/x/BQBXu) når nye repoer opprettes.
+## [MÅ]{.must} følge [SSBs retningslinjer](https://adr.ssb.no/0006-aapen-kildekode-i-ssb/) for åpenkildekode.
+## [MÅ]{.must} anvende [Feature Branch](https://martinfowler.com/bliki/FeatureBranch.html) mønster.
+## [MÅ]{.must} unngå å legge [hemmeligheter](https://statistics-norway.atlassian.net/wiki/x/JIDZyQ) under versjonskontroll.