[WIP] Initiele versie interface en gedrag

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{html,md}]
+indent_size = 2
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2

.github/workflows/lint.yaml

@@ -0,0 +1,27 @@
+name: Lint and check files
+
+on:
+  workflow_call:
+
+jobs:
+  lint-markdown:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Lint
+        run: make lint
+  check-diagrams:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Make diagrams
+        run: make --always-make diagrams
+      - name: Check
+        run: |
+          if OUTPUT=$(git status --porcelain diagrams) && [ -n "${OUTPUT}" ]; then
+            echo "Found generated diagrams that do not match the source:"
+            echo "${OUTPUT}"
+            false
+          fi

.github/workflows/publish.yaml

@@ -0,0 +1,53 @@
+name: Publish
+
+on:
+  push:
+    branches: [develop]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yaml
+  build:
+    runs-on: ubuntu-latest
+    needs: lint
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Make snapshot
+        run: make snapshot
+      - name: Upload snapshot
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: build
+          retention-days: 1
+  deploy:
+    environment:
+      name: GitHub Pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Download snapshot
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "."
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,3 +1 @@
-snapshot.html
-template.pdf
-
+/build

.markdownlint-cli2.yaml

@@ -0,0 +1,4 @@
+globs:
+  - docs/besluiten
+  - sections
+  - README.md

.markdownlint.yaml

@@ -0,0 +1,23 @@
+default: true
+
+heading-style:
+  style: atx
+
+ul-style:
+  style: dash
+
+no-multiple-blanks:
+  maximum: 2
+
+line-length:
+  line_length: 120
+
+blanks-around-headings:
+  lines_above: 2
+
+no-duplicate-heading:
+  siblings_only: true
+
+no-inline-html:
+  allowed_elements:
+    - section

Makefile

@@ -0,0 +1,41 @@
+RESPEC_VERSION := latest
+RESPEC_IMAGE := registry.gitlab.com/commonground/nlx/fsc-base-image/respec:$(RESPEC_VERSION)
+
+PLANTUML_VERSION := latest
+PLANTUML_IMAGE := registry.gitlab.com/commonground/nlx/fsc-base-image/plantuml:${PLANTUML_VERSION}
+
+MARKDOWNLINT_VERSION := v0.13.0
+MARKDOWNLINT_IMAGE := docker.io/davidanson/markdownlint-cli2:${MARKDOWNLINT_VERSION}
+
+BUILD_DIR := build
+CWD := $(shell pwd)
+
+
+.PHONY: snapshot
+snapshot: diagrams
+	mkdir -p ${BUILD_DIR}/$<
+	cp -a $</*.svg ${BUILD_DIR}/$<
+	docker run --rm --volume ${CWD}:/app ${RESPEC_IMAGE} --disable-sandbox --localhost --src index.html --out build/index.html
+
+.PHONY: diagrams
+diagrams: $(patsubst %.puml,%.svg,$(wildcard diagrams/*.puml))
+
+diagrams/%.svg: diagrams/%.puml
+	cat $< | docker run --rm  --interactive ${PLANTUML_IMAGE} -svg > $@
+
+.PHONY: lint
+lint:
+	docker run --rm --volume ${CWD}:/workdir ${MARKDOWNLINT_IMAGE}
+
+.PHONY: serve
+serve:
+	@python3 -m http.server --bind 127.0.0.1 9000
+
+.PHONY: serve-snapshot
+serve-snapshot:
+	@python3 -m http.server --bind 127.0.0.1 --directory build 9001
+
+.PHONY: clean
+clean:
+	rm -rf ${BUILD_DIR}
+	rm -rf diagrams/*.svg

README.md

@@ -1 +1,21 @@
-# Standaard logboek dataverwerkingen
+# Logboek dataverwerkingen
+
+
+## Gebruik
+
+```sh
+# Start een webserver
+make serve
+
+# Genereer afbeeldingen van PlantUML-diagrammen
+make diagrams
+
+# Maak een statische versie
+make snapshot
+
+# Bekijk de statische versie
+make serve-snapshot
+
+# Verwijder de statische versie
+make clean
+```

config.js

@@ -0,0 +1,39 @@
+const localConfig = {
+  shortName: "logboek-dataverwerkingen",
+  publishDate: "2024-03-01",
+  publishVersion: "0.1.0",
+  github: "MinBZK/Logboek-Dataverwerkingen",
+
+  license: "cc-by",
+  specStatus: "wv",
+  specType: "st",
+  pubDomain: "",
+  useLogo: true,
+  useLabel: true,
+  maxTocLevel: 3,
+
+  postProcess: [window.respecMermaid.createFigures],
+
+  editors: [
+    {
+      name: "Logius Standaarden",
+      company: "Logius",
+      companyURL: "https://github.com/Logius-standaarden",
+    },
+  ],
+  authors: [
+    {
+      name: "Ministerie van Binnenlandse Zaken en Koninkrijksrelaties",
+      company: "Ministerie van Binnenlandse Zaken en Koninkrijksrelaties",
+      companyURL: "https://www.minbzk.nl/",
+    },
+  ],
+
+  lint: {
+    "local-refs-exist": true,
+    "no-http-props": true,
+    "no-unused-vars": true,
+  },
+};
+
+const respecConfig = {...organisationConfig, ...localConfig}

diagrams/general-architecture.puml

@@ -0,0 +1,32 @@
+@startuml
+header: UML Component Diagram
+title Context standaard Logboek Dataverwerkingen
+
+frame "Verantwoordelijke A" {
+
+    component "Logboek" as loggerA
+    component "Applicatie" as softwareA
+    component "Register" as registerA
+}
+frame "Verantwoordelijke B" {
+
+    component "Logboek" as loggerB
+    component "Applicatie" as softwareB
+    component "Register" as registerB
+}
+
+loggerA <-[bold,#green]u- softwareA
+registerA -[hidden]u- softwareA
+registerA -[dashed,#green]r- loggerA
+
+loggerB <-[bold,#green]u- softwareB
+registerB -[hidden]u- softwareB
+loggerB -[dashed,#green]r- registerB
+
+softwareA -[bold,#green]l-> softwareB
+
+skinparam boxPadding 50
+skinparam linetype polyline
+skinparam linetype ortho
+@enduml
+

docs/besluiten/0000-gebruik-van-adr.md

@@ -0,0 +1,22 @@
+# Gebruik van ADR
+
+- Status: draft
+- Datum:
+
+
+## Context en probleemstelling
+
+{ Beschrijf de context en de probleemstelling }
+
+
+## Besluit
+
+{ Beschrijf het genomen besluit }
+
+
+## Gevolgen
+
+{ Wat zijn de gevolgen na het nemen van dit besluit }
+
+
+## Meer informatie