Add plugin to show document contributors (#51)

MinBZK · Mar 7, 2024 · ba4af2b · ba4af2b
2 parents 4aa8b10 + aa5f1c5
commit ba4af2b
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 76 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ venv
 .venv
 build
 site
+.cache
diff --git 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
 
@@ -30,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
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,12 +1,4 @@
----
-    title: ADR-0007 Commit convention
----
-
-|     |                  |
-| ---     | --- |
-| Author  | Berry den Hartog |
-| Created | 28-Feb-2024      |
-| Status  | Accepted         |
+# ADR-0007 Commit convention
 
 ## Context
 

diff --git 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
@@ -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
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,4 @@ venv @@
     .venv
     build
     site
+    .cache