From cc6a8c95e5db4772a30749c3fee0033ad702e60d Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Fri, 31 May 2024 15:16:31 +0100 Subject: [PATCH] Move collections. --- .devcontainer/devcontainer.json | 9 ++-- docs/_config.yml | 2 +- ...on_to_check_the_editorconfig_compliance.md | 17 +++---- ...2_Scan_repository_for_hardcoded_secrets.md | 0 ...GitHub_PAT_and_Apps_for_authN_and_authZ.md | 15 +++--- .../_adrs/adr-004-github.md | 34 ++++++++++++- .../_adrs/adr-005-git-docs.md | 0 .../_adrs/adr-006-github-hosted-runners.md | 0 .../_adrs/adr-007-naming-conventions.md | 1 - .../_adrs/adr-008-public-adrs.md | 0 .../_adrs/adrs-active.md | 3 +- .../assets/ADR-003/examples/bash/README.md | 0 .../assets/ADR-003/examples/bash/script.sh | 0 .../assets/ADR-003/examples/golang/README.md | 0 .../assets/ADR-003/examples/golang/go.mod | 0 .../assets/ADR-003/examples/golang/go.sum | 0 .../assets/ADR-003/examples/golang/main.go | 0 .../assets/ADR-003/examples/nodejs/.gitignore | 0 .../assets/ADR-003/examples/nodejs/README.md | 0 .../assets/ADR-003/examples/nodejs/main.ts | 0 .../ADR-003/examples/nodejs/package.json | 0 .../ADR-003/examples/nodejs/tsconfig.json | 0 .../assets/ADR-003/examples/python/README.md | 0 .../assets/ADR-003/examples/python/main.py | 0 .../ADR-003/examples/python/requirements.txt | 0 .../ADR-XXX_Agree_CICD_pipeline_structure.md | 0 .../ADR-nnn_Any_Decision_Record_Template.md | 48 ++++++++++-------- .../_architecture/1_logical.md | 0 .../_architecture/2_development.md | 0 .../_architecture/3_process.md | 0 .../_architecture/4_physical.md | 0 .../_architecture/5_scenarios.md | 0 .../_architecture/index.md | 0 .../assets/Bounded_Context.drawio.png | Bin .../physical/assets/Domains.drawio.png | Bin ..._account_structure_for_new_architecture.md | 0 .../sub-domains_and_bounded_contexts.md | 0 .../_guides/developer-guides/Bash_and_Make.md | 0 .../developer-guides/Scripting_Docker.md | 0 .../developer-guides/Scripting_Terraform.md | 0 .../developer-guides/assets/make_help.png | Bin .../_guides/developer-guides/dev-guides.md | 0 .../user-guides/Perform_static_analysis.md | 0 .../user-guides/Run_Git_hooks_on_commit.md | 0 .../_guides/user-guides/Scan_dependencies.md | 0 .../_guides/user-guides/Scan_secrets.md | 0 .../_guides/user-guides/Sign_Git_commits.md | 0 .../Test_GitHub_Actions_locally.md | 0 .../_guides/user-guides/drawio.md | 0 .../_guides/user-guides/mermaid-diagrams.md | 0 .../_guides/user-guides/user-guides.md | 0 .../2024-05-22-welcome-to-jekyll.markdown | 0 .../_principles/accelerate-dora.md | 0 .../_principles/domain-driven-design.md | 0 .../_principles/goals.md | 0 .../_principles/index.md | 0 .../_principles/micro-front-ends.md | 0 .../_principles/team-topologies.md | 0 .../_repos/index.md | 0 .../_repos/nhs-notify-dns.md | 0 .../_repos/nhs-notify-iam.md | 0 .../_repos/nhs-notify-repository-template.md | 0 .../_repos/nhs-notify-web-cms.md | 0 .../_repos/nhs-notify-web-platform.md | 0 .../nhs-notify-web-template-management.md | 0 .../_repos/nhs-notify.md | 0 nhs-notify.code-workspace | 20 +++++++- 67 files changed, 96 insertions(+), 53 deletions(-) rename docs/{_collections => collections}/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md (92%) rename docs/{_collections => collections}/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md (100%) rename docs/{_collections => collections}/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md (97%) rename docs/{_collections => collections}/_adrs/adr-004-github.md (62%) rename docs/{_collections => collections}/_adrs/adr-005-git-docs.md (100%) rename docs/{_collections => collections}/_adrs/adr-006-github-hosted-runners.md (100%) rename docs/{_collections => collections}/_adrs/adr-007-naming-conventions.md (99%) rename docs/{_collections => collections}/_adrs/adr-008-public-adrs.md (100%) rename docs/{_collections => collections}/_adrs/adrs-active.md (90%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/bash/README.md (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/bash/script.sh (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/golang/README.md (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/golang/go.mod (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/golang/go.sum (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/golang/main.go (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/nodejs/.gitignore (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/nodejs/README.md (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/nodejs/main.ts (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/nodejs/package.json (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/python/README.md (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/python/main.py (100%) rename docs/{_collections => collections}/_adrs/assets/ADR-003/examples/python/requirements.txt (100%) rename docs/{_collections/_adrs => collections/_adrs/templates}/ADR-XXX_Agree_CICD_pipeline_structure.md (100%) rename docs/{_collections/_adrs => collections/_adrs/templates}/ADR-nnn_Any_Decision_Record_Template.md (75%) rename docs/{_collections => collections}/_architecture/1_logical.md (100%) rename docs/{_collections => collections}/_architecture/2_development.md (100%) rename docs/{_collections => collections}/_architecture/3_process.md (100%) rename docs/{_collections => collections}/_architecture/4_physical.md (100%) rename docs/{_collections => collections}/_architecture/5_scenarios.md (100%) rename docs/{_collections => collections}/_architecture/index.md (100%) rename docs/{_collections => collections}/_architecture/physical/assets/Bounded_Context.drawio.png (100%) rename docs/{_collections => collections}/_architecture/physical/assets/Domains.drawio.png (100%) rename docs/{_collections => collections}/_architecture/physical/initial_account_structure_for_new_architecture.md (100%) rename docs/{_collections => collections}/_architecture/physical/sub-domains_and_bounded_contexts.md (100%) rename docs/{_collections => collections}/_guides/developer-guides/Bash_and_Make.md (100%) rename docs/{_collections => collections}/_guides/developer-guides/Scripting_Docker.md (100%) rename docs/{_collections => collections}/_guides/developer-guides/Scripting_Terraform.md (100%) rename docs/{_collections => collections}/_guides/developer-guides/assets/make_help.png (100%) rename docs/{_collections => collections}/_guides/developer-guides/dev-guides.md (100%) rename docs/{_collections => collections}/_guides/user-guides/Perform_static_analysis.md (100%) rename docs/{_collections => collections}/_guides/user-guides/Run_Git_hooks_on_commit.md (100%) rename docs/{_collections => collections}/_guides/user-guides/Scan_dependencies.md (100%) rename docs/{_collections => collections}/_guides/user-guides/Scan_secrets.md (100%) rename docs/{_collections => collections}/_guides/user-guides/Sign_Git_commits.md (100%) rename docs/{_collections => collections}/_guides/user-guides/Test_GitHub_Actions_locally.md (100%) rename docs/{_collections => collections}/_guides/user-guides/drawio.md (100%) rename docs/{_collections => collections}/_guides/user-guides/mermaid-diagrams.md (100%) rename docs/{_collections => collections}/_guides/user-guides/user-guides.md (100%) rename docs/{ => collections}/_posts/2024-05-22-welcome-to-jekyll.markdown (100%) rename docs/{_collections => collections}/_principles/accelerate-dora.md (100%) rename docs/{_collections => collections}/_principles/domain-driven-design.md (100%) rename docs/{_collections => collections}/_principles/goals.md (100%) rename docs/{_collections => collections}/_principles/index.md (100%) rename docs/{_collections => collections}/_principles/micro-front-ends.md (100%) rename docs/{_collections => collections}/_principles/team-topologies.md (100%) rename docs/{_collections => collections}/_repos/index.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify-dns.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify-iam.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify-repository-template.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify-web-cms.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify-web-platform.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify-web-template-management.md (100%) rename docs/{_collections => collections}/_repos/nhs-notify.md (100%) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index d117d32..d818847 100644 --- a/.devcontainer/devcontainer.json +++ b/.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" ] } }, diff --git a/docs/_config.yml b/docs/_config.yml index 6dcf8cf..5b8048a 100644 --- a/docs/_config.yml +++ b/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: diff --git a/docs/_collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md b/docs/collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md similarity index 92% rename from docs/_collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md rename to docs/collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md index 90681b8..1ea725c 100644 --- a/docs/_collections/_adrs/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md +++ b/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) diff --git a/docs/_collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md b/docs/collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md similarity index 100% rename from docs/_collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md rename to docs/collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md diff --git a/docs/_collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md b/docs/collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md similarity index 97% rename from docs/_collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md rename to docs/collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md index 595b6c3..55c399c 100644 --- a/docs/_collections/_adrs/ADR-003_Acceptable_use_of_GitHub_PAT_and_Apps_for_authN_and_authZ.md +++ b/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` | --- diff --git a/docs/_collections/_adrs/adr-004-github.md b/docs/collections/_adrs/adr-004-github.md similarity index 62% rename from docs/_collections/_adrs/adr-004-github.md rename to docs/collections/_adrs/adr-004-github.md index e2344f2..888627e 100644 --- a/docs/_collections/_adrs/adr-004-github.md +++ b/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 diff --git a/docs/_collections/_adrs/adr-005-git-docs.md b/docs/collections/_adrs/adr-005-git-docs.md similarity index 100% rename from docs/_collections/_adrs/adr-005-git-docs.md rename to docs/collections/_adrs/adr-005-git-docs.md diff --git a/docs/_collections/_adrs/adr-006-github-hosted-runners.md b/docs/collections/_adrs/adr-006-github-hosted-runners.md similarity index 100% rename from docs/_collections/_adrs/adr-006-github-hosted-runners.md rename to docs/collections/_adrs/adr-006-github-hosted-runners.md diff --git a/docs/_collections/_adrs/adr-007-naming-conventions.md b/docs/collections/_adrs/adr-007-naming-conventions.md similarity index 99% rename from docs/_collections/_adrs/adr-007-naming-conventions.md rename to docs/collections/_adrs/adr-007-naming-conventions.md index f03c399..9223ac4 100644 --- a/docs/_collections/_adrs/adr-007-naming-conventions.md +++ b/docs/collections/_adrs/adr-007-naming-conventions.md @@ -1,5 +1,4 @@ --- - title: ADR-007 parent: Active ADRs description: Naming Conventions diff --git a/docs/_collections/_adrs/adr-008-public-adrs.md b/docs/collections/_adrs/adr-008-public-adrs.md similarity index 100% rename from docs/_collections/_adrs/adr-008-public-adrs.md rename to docs/collections/_adrs/adr-008-public-adrs.md diff --git a/docs/_collections/_adrs/adrs-active.md b/docs/collections/_adrs/adrs-active.md similarity index 90% rename from docs/_collections/_adrs/adrs-active.md rename to docs/collections/_adrs/adrs-active.md index 5f20878..238db94 100644 --- a/docs/_collections/_adrs/adrs-active.md +++ b/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/ diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/bash/README.md b/docs/collections/_adrs/assets/ADR-003/examples/bash/README.md similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/bash/README.md rename to docs/collections/_adrs/assets/ADR-003/examples/bash/README.md diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/bash/script.sh b/docs/collections/_adrs/assets/ADR-003/examples/bash/script.sh similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/bash/script.sh rename to docs/collections/_adrs/assets/ADR-003/examples/bash/script.sh diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/golang/README.md b/docs/collections/_adrs/assets/ADR-003/examples/golang/README.md similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/golang/README.md rename to docs/collections/_adrs/assets/ADR-003/examples/golang/README.md diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/golang/go.mod b/docs/collections/_adrs/assets/ADR-003/examples/golang/go.mod similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/golang/go.mod rename to docs/collections/_adrs/assets/ADR-003/examples/golang/go.mod diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/golang/go.sum b/docs/collections/_adrs/assets/ADR-003/examples/golang/go.sum similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/golang/go.sum rename to docs/collections/_adrs/assets/ADR-003/examples/golang/go.sum diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/golang/main.go b/docs/collections/_adrs/assets/ADR-003/examples/golang/main.go similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/golang/main.go rename to docs/collections/_adrs/assets/ADR-003/examples/golang/main.go diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/.gitignore b/docs/collections/_adrs/assets/ADR-003/examples/nodejs/.gitignore similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/nodejs/.gitignore rename to docs/collections/_adrs/assets/ADR-003/examples/nodejs/.gitignore diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/README.md b/docs/collections/_adrs/assets/ADR-003/examples/nodejs/README.md similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/nodejs/README.md rename to docs/collections/_adrs/assets/ADR-003/examples/nodejs/README.md diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/main.ts b/docs/collections/_adrs/assets/ADR-003/examples/nodejs/main.ts similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/nodejs/main.ts rename to docs/collections/_adrs/assets/ADR-003/examples/nodejs/main.ts diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/package.json b/docs/collections/_adrs/assets/ADR-003/examples/nodejs/package.json similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/nodejs/package.json rename to docs/collections/_adrs/assets/ADR-003/examples/nodejs/package.json diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json b/docs/collections/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json rename to docs/collections/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/python/README.md b/docs/collections/_adrs/assets/ADR-003/examples/python/README.md similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/python/README.md rename to docs/collections/_adrs/assets/ADR-003/examples/python/README.md diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/python/main.py b/docs/collections/_adrs/assets/ADR-003/examples/python/main.py similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/python/main.py rename to docs/collections/_adrs/assets/ADR-003/examples/python/main.py diff --git a/docs/_collections/_adrs/assets/ADR-003/examples/python/requirements.txt b/docs/collections/_adrs/assets/ADR-003/examples/python/requirements.txt similarity index 100% rename from docs/_collections/_adrs/assets/ADR-003/examples/python/requirements.txt rename to docs/collections/_adrs/assets/ADR-003/examples/python/requirements.txt diff --git a/docs/_collections/_adrs/ADR-XXX_Agree_CICD_pipeline_structure.md b/docs/collections/_adrs/templates/ADR-XXX_Agree_CICD_pipeline_structure.md similarity index 100% rename from docs/_collections/_adrs/ADR-XXX_Agree_CICD_pipeline_structure.md rename to docs/collections/_adrs/templates/ADR-XXX_Agree_CICD_pipeline_structure.md diff --git a/docs/_collections/_adrs/ADR-nnn_Any_Decision_Record_Template.md b/docs/collections/_adrs/templates/ADR-nnn_Any_Decision_Record_Template.md similarity index 75% rename from docs/_collections/_adrs/ADR-nnn_Any_Decision_Record_Template.md rename to docs/collections/_adrs/templates/ADR-nnn_Any_Decision_Record_Template.md index dcca708..32a63a6 100644 --- a/docs/_collections/_adrs/ADR-nnn_Any_Decision_Record_Template.md +++ b/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 diff --git a/docs/_collections/_architecture/1_logical.md b/docs/collections/_architecture/1_logical.md similarity index 100% rename from docs/_collections/_architecture/1_logical.md rename to docs/collections/_architecture/1_logical.md diff --git a/docs/_collections/_architecture/2_development.md b/docs/collections/_architecture/2_development.md similarity index 100% rename from docs/_collections/_architecture/2_development.md rename to docs/collections/_architecture/2_development.md diff --git a/docs/_collections/_architecture/3_process.md b/docs/collections/_architecture/3_process.md similarity index 100% rename from docs/_collections/_architecture/3_process.md rename to docs/collections/_architecture/3_process.md diff --git a/docs/_collections/_architecture/4_physical.md b/docs/collections/_architecture/4_physical.md similarity index 100% rename from docs/_collections/_architecture/4_physical.md rename to docs/collections/_architecture/4_physical.md diff --git a/docs/_collections/_architecture/5_scenarios.md b/docs/collections/_architecture/5_scenarios.md similarity index 100% rename from docs/_collections/_architecture/5_scenarios.md rename to docs/collections/_architecture/5_scenarios.md diff --git a/docs/_collections/_architecture/index.md b/docs/collections/_architecture/index.md similarity index 100% rename from docs/_collections/_architecture/index.md rename to docs/collections/_architecture/index.md diff --git a/docs/_collections/_architecture/physical/assets/Bounded_Context.drawio.png b/docs/collections/_architecture/physical/assets/Bounded_Context.drawio.png similarity index 100% rename from docs/_collections/_architecture/physical/assets/Bounded_Context.drawio.png rename to docs/collections/_architecture/physical/assets/Bounded_Context.drawio.png diff --git a/docs/_collections/_architecture/physical/assets/Domains.drawio.png b/docs/collections/_architecture/physical/assets/Domains.drawio.png similarity index 100% rename from docs/_collections/_architecture/physical/assets/Domains.drawio.png rename to docs/collections/_architecture/physical/assets/Domains.drawio.png diff --git a/docs/_collections/_architecture/physical/initial_account_structure_for_new_architecture.md b/docs/collections/_architecture/physical/initial_account_structure_for_new_architecture.md similarity index 100% rename from docs/_collections/_architecture/physical/initial_account_structure_for_new_architecture.md rename to docs/collections/_architecture/physical/initial_account_structure_for_new_architecture.md diff --git a/docs/_collections/_architecture/physical/sub-domains_and_bounded_contexts.md b/docs/collections/_architecture/physical/sub-domains_and_bounded_contexts.md similarity index 100% rename from docs/_collections/_architecture/physical/sub-domains_and_bounded_contexts.md rename to docs/collections/_architecture/physical/sub-domains_and_bounded_contexts.md diff --git a/docs/_collections/_guides/developer-guides/Bash_and_Make.md b/docs/collections/_guides/developer-guides/Bash_and_Make.md similarity index 100% rename from docs/_collections/_guides/developer-guides/Bash_and_Make.md rename to docs/collections/_guides/developer-guides/Bash_and_Make.md diff --git a/docs/_collections/_guides/developer-guides/Scripting_Docker.md b/docs/collections/_guides/developer-guides/Scripting_Docker.md similarity index 100% rename from docs/_collections/_guides/developer-guides/Scripting_Docker.md rename to docs/collections/_guides/developer-guides/Scripting_Docker.md diff --git a/docs/_collections/_guides/developer-guides/Scripting_Terraform.md b/docs/collections/_guides/developer-guides/Scripting_Terraform.md similarity index 100% rename from docs/_collections/_guides/developer-guides/Scripting_Terraform.md rename to docs/collections/_guides/developer-guides/Scripting_Terraform.md diff --git a/docs/_collections/_guides/developer-guides/assets/make_help.png b/docs/collections/_guides/developer-guides/assets/make_help.png similarity index 100% rename from docs/_collections/_guides/developer-guides/assets/make_help.png rename to docs/collections/_guides/developer-guides/assets/make_help.png diff --git a/docs/_collections/_guides/developer-guides/dev-guides.md b/docs/collections/_guides/developer-guides/dev-guides.md similarity index 100% rename from docs/_collections/_guides/developer-guides/dev-guides.md rename to docs/collections/_guides/developer-guides/dev-guides.md diff --git a/docs/_collections/_guides/user-guides/Perform_static_analysis.md b/docs/collections/_guides/user-guides/Perform_static_analysis.md similarity index 100% rename from docs/_collections/_guides/user-guides/Perform_static_analysis.md rename to docs/collections/_guides/user-guides/Perform_static_analysis.md diff --git a/docs/_collections/_guides/user-guides/Run_Git_hooks_on_commit.md b/docs/collections/_guides/user-guides/Run_Git_hooks_on_commit.md similarity index 100% rename from docs/_collections/_guides/user-guides/Run_Git_hooks_on_commit.md rename to docs/collections/_guides/user-guides/Run_Git_hooks_on_commit.md diff --git a/docs/_collections/_guides/user-guides/Scan_dependencies.md b/docs/collections/_guides/user-guides/Scan_dependencies.md similarity index 100% rename from docs/_collections/_guides/user-guides/Scan_dependencies.md rename to docs/collections/_guides/user-guides/Scan_dependencies.md diff --git a/docs/_collections/_guides/user-guides/Scan_secrets.md b/docs/collections/_guides/user-guides/Scan_secrets.md similarity index 100% rename from docs/_collections/_guides/user-guides/Scan_secrets.md rename to docs/collections/_guides/user-guides/Scan_secrets.md diff --git a/docs/_collections/_guides/user-guides/Sign_Git_commits.md b/docs/collections/_guides/user-guides/Sign_Git_commits.md similarity index 100% rename from docs/_collections/_guides/user-guides/Sign_Git_commits.md rename to docs/collections/_guides/user-guides/Sign_Git_commits.md diff --git a/docs/_collections/_guides/user-guides/Test_GitHub_Actions_locally.md b/docs/collections/_guides/user-guides/Test_GitHub_Actions_locally.md similarity index 100% rename from docs/_collections/_guides/user-guides/Test_GitHub_Actions_locally.md rename to docs/collections/_guides/user-guides/Test_GitHub_Actions_locally.md diff --git a/docs/_collections/_guides/user-guides/drawio.md b/docs/collections/_guides/user-guides/drawio.md similarity index 100% rename from docs/_collections/_guides/user-guides/drawio.md rename to docs/collections/_guides/user-guides/drawio.md diff --git a/docs/_collections/_guides/user-guides/mermaid-diagrams.md b/docs/collections/_guides/user-guides/mermaid-diagrams.md similarity index 100% rename from docs/_collections/_guides/user-guides/mermaid-diagrams.md rename to docs/collections/_guides/user-guides/mermaid-diagrams.md diff --git a/docs/_collections/_guides/user-guides/user-guides.md b/docs/collections/_guides/user-guides/user-guides.md similarity index 100% rename from docs/_collections/_guides/user-guides/user-guides.md rename to docs/collections/_guides/user-guides/user-guides.md diff --git a/docs/_posts/2024-05-22-welcome-to-jekyll.markdown b/docs/collections/_posts/2024-05-22-welcome-to-jekyll.markdown similarity index 100% rename from docs/_posts/2024-05-22-welcome-to-jekyll.markdown rename to docs/collections/_posts/2024-05-22-welcome-to-jekyll.markdown diff --git a/docs/_collections/_principles/accelerate-dora.md b/docs/collections/_principles/accelerate-dora.md similarity index 100% rename from docs/_collections/_principles/accelerate-dora.md rename to docs/collections/_principles/accelerate-dora.md diff --git a/docs/_collections/_principles/domain-driven-design.md b/docs/collections/_principles/domain-driven-design.md similarity index 100% rename from docs/_collections/_principles/domain-driven-design.md rename to docs/collections/_principles/domain-driven-design.md diff --git a/docs/_collections/_principles/goals.md b/docs/collections/_principles/goals.md similarity index 100% rename from docs/_collections/_principles/goals.md rename to docs/collections/_principles/goals.md diff --git a/docs/_collections/_principles/index.md b/docs/collections/_principles/index.md similarity index 100% rename from docs/_collections/_principles/index.md rename to docs/collections/_principles/index.md diff --git a/docs/_collections/_principles/micro-front-ends.md b/docs/collections/_principles/micro-front-ends.md similarity index 100% rename from docs/_collections/_principles/micro-front-ends.md rename to docs/collections/_principles/micro-front-ends.md diff --git a/docs/_collections/_principles/team-topologies.md b/docs/collections/_principles/team-topologies.md similarity index 100% rename from docs/_collections/_principles/team-topologies.md rename to docs/collections/_principles/team-topologies.md diff --git a/docs/_collections/_repos/index.md b/docs/collections/_repos/index.md similarity index 100% rename from docs/_collections/_repos/index.md rename to docs/collections/_repos/index.md diff --git a/docs/_collections/_repos/nhs-notify-dns.md b/docs/collections/_repos/nhs-notify-dns.md similarity index 100% rename from docs/_collections/_repos/nhs-notify-dns.md rename to docs/collections/_repos/nhs-notify-dns.md diff --git a/docs/_collections/_repos/nhs-notify-iam.md b/docs/collections/_repos/nhs-notify-iam.md similarity index 100% rename from docs/_collections/_repos/nhs-notify-iam.md rename to docs/collections/_repos/nhs-notify-iam.md diff --git a/docs/_collections/_repos/nhs-notify-repository-template.md b/docs/collections/_repos/nhs-notify-repository-template.md similarity index 100% rename from docs/_collections/_repos/nhs-notify-repository-template.md rename to docs/collections/_repos/nhs-notify-repository-template.md diff --git a/docs/_collections/_repos/nhs-notify-web-cms.md b/docs/collections/_repos/nhs-notify-web-cms.md similarity index 100% rename from docs/_collections/_repos/nhs-notify-web-cms.md rename to docs/collections/_repos/nhs-notify-web-cms.md diff --git a/docs/_collections/_repos/nhs-notify-web-platform.md b/docs/collections/_repos/nhs-notify-web-platform.md similarity index 100% rename from docs/_collections/_repos/nhs-notify-web-platform.md rename to docs/collections/_repos/nhs-notify-web-platform.md diff --git a/docs/_collections/_repos/nhs-notify-web-template-management.md b/docs/collections/_repos/nhs-notify-web-template-management.md similarity index 100% rename from docs/_collections/_repos/nhs-notify-web-template-management.md rename to docs/collections/_repos/nhs-notify-web-template-management.md diff --git a/docs/_collections/_repos/nhs-notify.md b/docs/collections/_repos/nhs-notify.md similarity index 100% rename from docs/_collections/_repos/nhs-notify.md rename to docs/collections/_repos/nhs-notify.md diff --git a/nhs-notify.code-workspace b/nhs-notify.code-workspace index ffe54d2..1eed561 100644 --- a/nhs-notify.code-workspace +++ b/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": [] }