Move collections.

.devcontainer/devcontainer.json

@@ -15,11 +15,7 @@
   // Configure tool-specific properties.
   "customizations": {
     "codespaces": {
-      "openFiles": [
-        "README.md",
-        ".github/SECURITY.md",
-        "docs/index.md"
-      ]
+      "openFiles": ["README.md", ".github/SECURITY.md", "docs/index.md"]
     },
     "vscode": {
       // Set *default* container specific settings.json values on container create.
@@ -64,7 +60,8 @@
         "yzane.markdown-pdf",
         "yzhang.dictionary-completion",
         "yzhang.markdown-all-in-one",
-        "joshx.workspace-terminals"
+        "joshx.workspace-terminals",
+        "takumii.markdowntable"
       ]
     }
   },

docs/_config.yml

@@ -25,7 +25,7 @@ description: >- # this means to ignore newlines until "baseurl:"
 baseurl: "/nhs-notify" # the subpath of your site, e.g. /blog
 url: "https://nhsdigital.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 
-collections_dir: _collections
+collections_dir: collections
 
 collections:
   repos:

docs/_collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md → docs/collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md

@@ -1,5 +1,4 @@
 ---
-
 title: ADR-001
 parent: Active ADRs
 description: Use git hook and GitHub Action to check the .editorconfig compliance
@@ -8,15 +7,13 @@ summary: Use git hook and GitHub Action to check the .editorconfig compliance
 
 ## ADR-001: Use git hook and GitHub Action to check the `.editorconfig` compliance
 
->|              |                                                      |
->| ------------ | ---------------------------------------------------- |
->| Date         | `04/07/2023`                                         |
->| Status       | `RFC`                                                |
->| Deciders     | `Engineering`                                        |
->| Significance | `Construction techniques`                            |
->| Owners       | `Dan Stefaniuk, Amaan Ibn-Nasar, Thomas Judd-Cooper` |
-
----
+> |              |                                                      |
+> | ------------ | ---------------------------------------------------- |
+> | Date         | `04/07/2023`                                         |
+> | Status       | `RFC`                                                |
+> | Deciders     | `Engineering`                                        |
+> | Significance | `Construction techniques`                            |
+> | Owners       | `Dan Stefaniuk, Amaan Ibn-Nasar, Thomas Judd-Cooper` |
 
 - [ADR-001: Use git hook and GitHub Action to check the `.editorconfig` compliance](#adr-001-use-git-hook-and-github-action-to-check-the-editorconfig-compliance)
 - [Context](#context)

docs/_collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md → docs/collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md

@@ -1,5 +1,4 @@
 ---
-
 title: ADR-003
 parent: Active ADRs
 description: Acceptable use of GitHub authentication and authorisation mechanisms
@@ -8,13 +7,13 @@ summary: Acceptable use of GitHub authentication and authorisation mechanisms
 
 ## ADR-003: Acceptable use of GitHub authentication and authorisation mechanisms
 
->|              | |
->| ------------ | --- |
->| Date         | `04/09/2023` |
->| Status       | `RFC` |
->| Deciders     | `Engineering` |
->| Significance | `Construction techniques` |
->| Owners       | `Amaan Ibn-Nasar, Jacob Gill, Dan Stefaniuk` |
+> |              |                                              |
+> | ------------ | -------------------------------------------- |
+> | Date         | `04/09/2023`                                 |
+> | Status       | `RFC`                                        |
+> | Deciders     | `Engineering`                                |
+> | Significance | `Construction techniques`                    |
+> | Owners       | `Amaan Ibn-Nasar, Jacob Gill, Dan Stefaniuk` |
 
 ---
 

docs/_collections/_adrs/adr-004-github.md → docs/collections/_adrs/adr-004-github.md

@@ -1,5 +1,4 @@
 ---
-
 title: ADR-004
 parent: Active ADRs
 description: GitHub as default git upstream location
@@ -16,9 +15,42 @@ summary: GitHub as default git upstream location
 | Significance | `Ross Buggins` |
 
 - [ADR-004: GitHub as default git upstream location](#adr-004-github-as-default-git-upstream-location)
+- [Context](#context)
 - [Decision](#decision)
+  - [Assumptions](#assumptions)
+  - [Drivers](#drivers)
+  - [Options](#options)
+  - [Outcome](#outcome)
+  - [Rationale](#rationale)
+- [Consequences](#consequences)
+- [Compliance](#compliance)
+- [Notes](#notes)
+- [Actions](#actions)
+- [Tags](#tags)
+
+## Context
 
 ## Decision
 
 - GitHub will be the default upstream origin for all new NHS Notify git repositories.
 - Existing repositories will be moved from the existing store.
+
+### Assumptions
+
+### Drivers
+
+### Options
+
+### Outcome
+
+### Rationale
+
+## Consequences
+
+## Compliance
+
+## Notes
+
+## Actions
+
+## Tags

docs/_collections/_adrs/adr-007-naming-conventions.md → docs/collections/_adrs/adr-007-naming-conventions.md

@@ -1,5 +1,4 @@
 ---
-
 title: ADR-007
 parent: Active ADRs
 description: Naming Conventions

docs/_collections/_adrs/adrs-active.md → docs/collections/_adrs/adrs-active.md

@@ -1,7 +1,6 @@
 ---
-
 title: Active ADRs
-nav_order: 2
+nav_order: 1
 has_children: true
 child_nav_order: reversed
 permalink: /adrs/

docs/_collections/_adrs/ADR-nnn_Any_Decision_Record_Template.md → docs/collections/_adrs/templates/ADR-nnn_Any_Decision_Record_Template.md

@@ -1,28 +1,32 @@
-# ADR-nnn: Any Decision Record Template
+---
+title: ADR Template
+nav_order: 2
+permalink: /adrs/template
+---
 
->|              |                                                                                                                                                                                    |
->| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
->| Date         | `dd/mm/YYYY` _when the decision was last updated_                                                                                                                                  |
->| Status       | `RFC by dd/mm/YYYY, Proposed, In Discussion, Pending Approval, Withdrawn, Rejected, Accepted, Deprecated, ..., Superseded by ADR-XXX or Supersedes ADR-XXX`                        |
->| Deciders     | `Tech Radar, Engineering, Architecture, Solution Assurance, Clinical Assurance, Technical Review and Governance, Information Governance, Cyber Security, Live Services Board,` ... |
->| Significance | `Structure, Nonfunctional characteristics, Dependencies, Interfaces, Construction techniques,` ...                                                                                 |
->| Owners       |                                                                                                                                                                                    |
+> |              |                                                                                                                                                                                    |
+> | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+> | Date         | `dd/mm/YYYY` _when the decision was last updated_                                                                                                                                  |
+> | Status       | `RFC by dd/mm/YYYY, Proposed, In Discussion, Pending Approval, Withdrawn, Rejected, Accepted, Deprecated, ..., Superseded by ADR-XXX or Supersedes ADR-XXX`                        |
+> | Deciders     | `Tech Radar, Engineering, Architecture, Solution Assurance, Clinical Assurance, Technical Review and Governance, Information Governance, Cyber Security, Live Services Board,` ... |
+> | Significance | `Structure, Nonfunctional characteristics, Dependencies, Interfaces, Construction techniques,` ...                                                                                 |
+> | Owners       |                                                                                                                                                                                    |
 
----
+## ADR-nnn: Any Decision Record Template
 
 - [ADR-nnn: Any Decision Record Template](#adr-nnn-any-decision-record-template)
-  - [Context](#context)
-  - [Decision](#decision)
-    - [Assumptions](#assumptions)
-    - [Drivers](#drivers)
-    - [Options](#options)
-    - [Outcome](#outcome)
-    - [Rationale](#rationale)
-  - [Consequences](#consequences)
-  - [Compliance](#compliance)
-  - [Notes](#notes)
-  - [Actions](#actions)
-  - [Tags](#tags)
+- [Context](#context)
+- [Decision](#decision)
+  - [Assumptions](#assumptions)
+  - [Drivers](#drivers)
+  - [Options](#options)
+  - [Outcome](#outcome)
+  - [Rationale](#rationale)
+- [Consequences](#consequences)
+- [Compliance](#compliance)
+- [Notes](#notes)
+- [Actions](#actions)
+- [Tags](#tags)
 
 ## Context
 
@@ -50,7 +54,7 @@ State the decision outcome as a result of taking into account all of the above.
 
 Provide a rationale for the decision that is based on weighing the options to ensure that the same questions are not going to be asked again and again unless the decision needs to be superseded.
 
-For non-trivial decisions a comparison table can be useful for the reviewer. Decision criteria down one side, options across the top. You'll likely find decision criteria come from the Drivers section above. Effort can be an important driving factor.  You may have an intuitive feel for this, but reviewers will not. T-shirt sizing the effort for each option may help communicate.
+For non-trivial decisions a comparison table can be useful for the reviewer. Decision criteria down one side, options across the top. You'll likely find decision criteria come from the Drivers section above. Effort can be an important driving factor. You may have an intuitive feel for this, but reviewers will not. T-shirt sizing the effort for each option may help communicate.
 
 ## Consequences
 

nhs-notify.code-workspace

@@ -29,7 +29,22 @@
       "ruleset",
       "Stefaniuk"
     ],
-    "cSpell.language": "en-GB"
+    "cSpell.language": "en-GB",
+    "editor.wordWrap": "off",
+    "editor.formatOnSave": true,
+    "[markdown]": {
+      "editor.wordWrap": "off",
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[jsonc]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[html]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[json]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    }
   },
   "extensions": {
     "recommendations": [
@@ -64,7 +79,8 @@
       "yzane.markdown-pdf",
       "yzhang.dictionary-completion",
       "yzhang.markdown-all-in-one",
-      "joshx.workspace-terminals"
+      "joshx.workspace-terminals",
+      "takumii.markdowntable"
     ],
     "unwantedRecommendations": []
   }