From c1ad1e5baa679e056ba22cd197717ec04faf82f9 Mon Sep 17 00:00:00 2001 From: Robbert Date: Wed, 6 Mar 2024 17:59:00 +0100 Subject: [PATCH 1/3] Add plugin to show document contributors --- .gitignore | 1 + mkdocs.yml | 5 ++++- requirements.txt | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 869bb299..4513f7c5 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ venv .venv build site +.cache diff --git a/mkdocs.yml b/mkdocs.yml index 807e57f7..201a68bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,10 +54,13 @@ extra_css: - stylesheets/extra.css plugins: + - search - glightbox - git-revision-date-localized: enable_creation_date: true - - search + - git-committers: + repository: minbzk/ai-validation + branch: main repo_url: https://github.com/MinBZK/ai-validation edit_uri: edit/main/docs/ diff --git a/requirements.txt b/requirements.txt index 6ab9111c..b0f2d8b8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,6 @@ Jinja2>=2.11.1 mkdocs==1.5.3 +mkdocs-git-committers-plugin-2==2.3.0 mkdocs-git-revision-date-localized-plugin==1.2.4 mkdocs-glightbox==0.3.7 mkdocs-material==9.5.12 From 45693b75a65dbc74e4cd04d774b7a961ad42f7bc Mon Sep 17 00:00:00 2001 From: Robbert Date: Wed, 6 Mar 2024 18:00:39 +0100 Subject: [PATCH 2/3] 'Move' author and created info to footer of the document using MkDocs plugins --- docs/ADRs/0001-adrs.md | 10 +--------- docs/ADRs/0002-code-platform.md | 10 +--------- docs/ADRs/0003-ci-cd.md | 10 +--------- docs/ADRs/0004-software-hosting-platform.md | 10 +--------- docs/ADRs/0005-python-tooling.md | 10 +--------- docs/ADRs/0006-agile-tooling.md | 9 +-------- docs/ADRs/0007-commit-convention.md | 10 +--------- 7 files changed, 7 insertions(+), 62 deletions(-) diff --git a/docs/ADRs/0001-adrs.md b/docs/ADRs/0001-adrs.md index 33d415eb..3dfc348a 100644 --- a/docs/ADRs/0001-adrs.md +++ b/docs/ADRs/0001-adrs.md @@ -1,12 +1,4 @@ ---- - title: ADR-0001 ADRs ---- - -| | | -| --- | --- | -| Author | Anne Schuth | -| Created | 16-Feb-2024 | -| Status | Accepted | +# ADR-0001 ADRs ## Context diff --git a/docs/ADRs/0002-code-platform.md b/docs/ADRs/0002-code-platform.md index 3ac20155..e1ec13a2 100644 --- a/docs/ADRs/0002-code-platform.md +++ b/docs/ADRs/0002-code-platform.md @@ -1,12 +1,4 @@ ---- - title: ADR-0002 Code Platform ---- - -| | | -| --- | --- | -| Author | Berry den Hartog | -| Created | 28-Feb-2024 | -| Status | Accepted | +# ADR-0002 Code Platform ## Context diff --git a/docs/ADRs/0003-ci-cd.md b/docs/ADRs/0003-ci-cd.md index 0bbcdac2..5762a516 100644 --- a/docs/ADRs/0003-ci-cd.md +++ b/docs/ADRs/0003-ci-cd.md @@ -1,12 +1,4 @@ ---- - title: ADR-0003 CI/CD Tooling ---- - -| | | -| --- | --- | -| Author | Berry den Hartog | -| Created | 28-Feb-2024 | -| Status | Accepted | +# ADR-0003 CI/CD Tooling ## Context diff --git a/docs/ADRs/0004-software-hosting-platform.md b/docs/ADRs/0004-software-hosting-platform.md index b4accc13..38c8bcc6 100644 --- a/docs/ADRs/0004-software-hosting-platform.md +++ b/docs/ADRs/0004-software-hosting-platform.md @@ -1,12 +1,4 @@ ---- - title: ADR-0004 Software hosting platform ---- - -| | | -| --- | --- | -| Author | Berry den Hartog | -| Created | 28-Feb-2024 | -| Status | Accepted | +# ADR-0004 Software hosting platform ## Context diff --git a/docs/ADRs/0005-python-tooling.md b/docs/ADRs/0005-python-tooling.md index 55577b36..e6bf1ffc 100644 --- a/docs/ADRs/0005-python-tooling.md +++ b/docs/ADRs/0005-python-tooling.md @@ -1,12 +1,4 @@ ---- - title: ADR-0005 Python coding standard and tools ---- - -| | | -| --- | --- | -| Author | Berry den Hartog | -| Created | 28-Feb-2024 | -| Status | Accepted | +# ADR-0005 Python coding standard and tools ## Context diff --git a/docs/ADRs/0006-agile-tooling.md b/docs/ADRs/0006-agile-tooling.md index b86fe683..4551d70f 100644 --- a/docs/ADRs/0006-agile-tooling.md +++ b/docs/ADRs/0006-agile-tooling.md @@ -1,12 +1,5 @@ ---- - title: ADR-0006 Agile tooling ---- -| | | -| --- | --- | -| Author | Berry den Hartog | -| Created | 28-Feb-2024 | -| Status | Accepted | +# ADR-0006 Agile tooling ## Context diff --git a/docs/ADRs/0007-commit-convention.md b/docs/ADRs/0007-commit-convention.md index 55c9fc22..be27304c 100644 --- a/docs/ADRs/0007-commit-convention.md +++ b/docs/ADRs/0007-commit-convention.md @@ -1,12 +1,4 @@ ---- - title: ADR-0007 Commit convention ---- - -| | | -| --- | --- | -| Author | Berry den Hartog | -| Created | 28-Feb-2024 | -| Status | Accepted | +# ADR-0007 Commit convention ## Context From aa5f1c52064ebb959acf19a2dd4f679fb3826f16 Mon Sep 17 00:00:00 2001 From: Robbert Date: Thu, 7 Mar 2024 06:48:26 +0100 Subject: [PATCH 3/3] Update ADR template --- docs/ADRs/0001-adrs.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/ADRs/0001-adrs.md b/docs/ADRs/0001-adrs.md index 3dfc348a..7ead4148 100644 --- a/docs/ADRs/0001-adrs.md +++ b/docs/ADRs/0001-adrs.md @@ -22,19 +22,8 @@ will publish these ADRs publicly to promote transparency and facilitate collabor Use the template below to add an ADR: -```yaml ---- - title: ADR-4 Title ---- - -| | | -| --- | --- | -| Author | Anne Schuth | -| Created | 28-Feb-2024 | -| Status | Draft, Proposed, Rejected, Accepted, Superseded | -| Superseded by | ADR-0001 | -| extends | ADR-0001, ADR-0002 | - +```markdown +# ADR-XXXX Title ## Context