diff --git a/docs/adr/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 99% rename from docs/adr/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 a3020cd..90681b8 100644 --- a/docs/adr/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,7 +1,7 @@ --- -layout: default + title: ADR-001 -parent: ADRs +parent: Active ADRs description: Use git hook and GitHub Action to check the .editorconfig compliance summary: Use git hook and GitHub Action to check the .editorconfig compliance --- diff --git a/docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md b/docs/_collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md similarity index 99% rename from docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md rename to docs/_collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md index a18dc62..49e4608 100644 --- a/docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md +++ b/docs/_collections/_adrs/ADR-002_Scan_repository_for_hardcoded_secrets.md @@ -1,7 +1,7 @@ --- -layout: default + title: ADR-002 -parent: ADRs +parent: Active ADRs description: Scan repository for hard-coded secrets summary: Scan repository for hard-coded secrets --- diff --git a/docs/adr/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 99% rename from docs/adr/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 be0a9af..595b6c3 100644 --- a/docs/adr/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,7 +1,7 @@ --- -layout: default + title: ADR-003 -parent: ADRs +parent: Active ADRs description: Acceptable use of GitHub authentication and authorisation mechanisms summary: Acceptable use of GitHub authentication and authorisation mechanisms --- diff --git a/docs/adr/ADR-XXX_Agree_CICD_pipeline_structure.md b/docs/_collections/_adrs/ADR-XXX_Agree_CICD_pipeline_structure.md similarity index 100% rename from docs/adr/ADR-XXX_Agree_CICD_pipeline_structure.md rename to docs/_collections/_adrs/ADR-XXX_Agree_CICD_pipeline_structure.md diff --git a/docs/adr/ADR-nnn_Any_Decision_Record_Template.md b/docs/_collections/_adrs/ADR-nnn_Any_Decision_Record_Template.md similarity index 100% rename from docs/adr/ADR-nnn_Any_Decision_Record_Template.md rename to docs/_collections/_adrs/ADR-nnn_Any_Decision_Record_Template.md diff --git a/docs/adr/adr-004-github.md b/docs/_collections/_adrs/adr-004-github.md similarity index 95% rename from docs/adr/adr-004-github.md rename to docs/_collections/_adrs/adr-004-github.md index 203b1cd..e2344f2 100644 --- a/docs/adr/adr-004-github.md +++ b/docs/_collections/_adrs/adr-004-github.md @@ -1,7 +1,7 @@ --- -layout: default + title: ADR-004 -parent: ADRs +parent: Active ADRs description: GitHub as default git upstream location summary: GitHub as default git upstream location --- diff --git a/docs/adr/adr-005-git-docs.md b/docs/_collections/_adrs/adr-005-git-docs.md similarity index 96% rename from docs/adr/adr-005-git-docs.md rename to docs/_collections/_adrs/adr-005-git-docs.md index cc671b0..d4d36e7 100644 --- a/docs/adr/adr-005-git-docs.md +++ b/docs/_collections/_adrs/adr-005-git-docs.md @@ -1,7 +1,7 @@ --- -layout: default + title: ADR-005 -parent: ADRs +parent: Active ADRs description: Documentation stored within repo summary: Documentation stored within repo --- diff --git a/docs/adr/adr-006-github-hosted-runners.md b/docs/_collections/_adrs/adr-006-github-hosted-runners.md similarity index 94% rename from docs/adr/adr-006-github-hosted-runners.md rename to docs/_collections/_adrs/adr-006-github-hosted-runners.md index a18a729..1878354 100644 --- a/docs/adr/adr-006-github-hosted-runners.md +++ b/docs/_collections/_adrs/adr-006-github-hosted-runners.md @@ -1,7 +1,7 @@ --- -layout: default + title: ADR-006 -parent: ADRs +parent: Active ADRs description: GitHub-hosted runners summary: GitHub-hosted runners --- diff --git a/docs/adr/adr-007-naming-conventions.md b/docs/_collections/_adrs/adr-007-naming-conventions.md similarity index 96% rename from docs/adr/adr-007-naming-conventions.md rename to docs/_collections/_adrs/adr-007-naming-conventions.md index a004a30..f03c399 100644 --- a/docs/adr/adr-007-naming-conventions.md +++ b/docs/_collections/_adrs/adr-007-naming-conventions.md @@ -1,7 +1,7 @@ --- -layout: default + title: ADR-007 -parent: ADRs +parent: Active ADRs description: Naming Conventions summary: Naming Conventions --- diff --git a/docs/adr/adr-008-public-adrs.md b/docs/_collections/_adrs/adr-008-public-adrs.md similarity index 95% rename from docs/adr/adr-008-public-adrs.md rename to docs/_collections/_adrs/adr-008-public-adrs.md index 887859f..bd0a13d 100644 --- a/docs/adr/adr-008-public-adrs.md +++ b/docs/_collections/_adrs/adr-008-public-adrs.md @@ -1,7 +1,7 @@ --- -layout: default + title: ADR-008 -parent: ADRs +parent: Active ADRs description: Programme wide public ADRS summary: Programme wide public ADRS --- diff --git a/docs/adrs.md b/docs/_collections/_adrs/adrs-active.md similarity index 75% rename from docs/adrs.md rename to docs/_collections/_adrs/adrs-active.md index 09dc82d..5f20878 100644 --- a/docs/adrs.md +++ b/docs/_collections/_adrs/adrs-active.md @@ -1,9 +1,10 @@ --- -layout: default -title: ADRs + +title: Active ADRs nav_order: 2 has_children: true child_nav_order: reversed +permalink: /adrs/ --- ## NHS Notify Architecture Decision Records (ADR) diff --git a/docs/adr/assets/ADR-003/examples/bash/README.md b/docs/_collections/_adrs/assets/ADR-003/examples/bash/README.md similarity index 100% rename from docs/adr/assets/ADR-003/examples/bash/README.md rename to docs/_collections/_adrs/assets/ADR-003/examples/bash/README.md diff --git a/docs/adr/assets/ADR-003/examples/bash/script.sh b/docs/_collections/_adrs/assets/ADR-003/examples/bash/script.sh similarity index 100% rename from docs/adr/assets/ADR-003/examples/bash/script.sh rename to docs/_collections/_adrs/assets/ADR-003/examples/bash/script.sh diff --git a/docs/adr/assets/ADR-003/examples/golang/README.md b/docs/_collections/_adrs/assets/ADR-003/examples/golang/README.md similarity index 100% rename from docs/adr/assets/ADR-003/examples/golang/README.md rename to docs/_collections/_adrs/assets/ADR-003/examples/golang/README.md diff --git a/docs/adr/assets/ADR-003/examples/golang/go.mod b/docs/_collections/_adrs/assets/ADR-003/examples/golang/go.mod similarity index 100% rename from docs/adr/assets/ADR-003/examples/golang/go.mod rename to docs/_collections/_adrs/assets/ADR-003/examples/golang/go.mod diff --git a/docs/adr/assets/ADR-003/examples/golang/go.sum b/docs/_collections/_adrs/assets/ADR-003/examples/golang/go.sum similarity index 100% rename from docs/adr/assets/ADR-003/examples/golang/go.sum rename to docs/_collections/_adrs/assets/ADR-003/examples/golang/go.sum diff --git a/docs/adr/assets/ADR-003/examples/golang/main.go b/docs/_collections/_adrs/assets/ADR-003/examples/golang/main.go similarity index 100% rename from docs/adr/assets/ADR-003/examples/golang/main.go rename to docs/_collections/_adrs/assets/ADR-003/examples/golang/main.go diff --git a/docs/adr/assets/ADR-003/examples/nodejs/.gitignore b/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/.gitignore similarity index 100% rename from docs/adr/assets/ADR-003/examples/nodejs/.gitignore rename to docs/_collections/_adrs/assets/ADR-003/examples/nodejs/.gitignore diff --git a/docs/adr/assets/ADR-003/examples/nodejs/README.md b/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/README.md similarity index 100% rename from docs/adr/assets/ADR-003/examples/nodejs/README.md rename to docs/_collections/_adrs/assets/ADR-003/examples/nodejs/README.md diff --git a/docs/adr/assets/ADR-003/examples/nodejs/main.ts b/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/main.ts similarity index 100% rename from docs/adr/assets/ADR-003/examples/nodejs/main.ts rename to docs/_collections/_adrs/assets/ADR-003/examples/nodejs/main.ts diff --git a/docs/adr/assets/ADR-003/examples/nodejs/package.json b/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/package.json similarity index 100% rename from docs/adr/assets/ADR-003/examples/nodejs/package.json rename to docs/_collections/_adrs/assets/ADR-003/examples/nodejs/package.json diff --git a/docs/adr/assets/ADR-003/examples/nodejs/tsconfig.json b/docs/_collections/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json similarity index 100% rename from docs/adr/assets/ADR-003/examples/nodejs/tsconfig.json rename to docs/_collections/_adrs/assets/ADR-003/examples/nodejs/tsconfig.json diff --git a/docs/adr/assets/ADR-003/examples/python/README.md b/docs/_collections/_adrs/assets/ADR-003/examples/python/README.md similarity index 100% rename from docs/adr/assets/ADR-003/examples/python/README.md rename to docs/_collections/_adrs/assets/ADR-003/examples/python/README.md diff --git a/docs/adr/assets/ADR-003/examples/python/main.py b/docs/_collections/_adrs/assets/ADR-003/examples/python/main.py similarity index 100% rename from docs/adr/assets/ADR-003/examples/python/main.py rename to docs/_collections/_adrs/assets/ADR-003/examples/python/main.py diff --git a/docs/adr/assets/ADR-003/examples/python/requirements.txt b/docs/_collections/_adrs/assets/ADR-003/examples/python/requirements.txt similarity index 100% rename from docs/adr/assets/ADR-003/examples/python/requirements.txt rename to docs/_collections/_adrs/assets/ADR-003/examples/python/requirements.txt diff --git a/docs/architecture/1_logical.md b/docs/_collections/_architecture/1_logical.md similarity index 87% rename from docs/architecture/1_logical.md rename to docs/_collections/_architecture/1_logical.md index 0872373..c55294d 100644 --- a/docs/architecture/1_logical.md +++ b/docs/_collections/_architecture/1_logical.md @@ -1,5 +1,4 @@ --- -layout: default title: Logical View parent: Architecture nav_order: 1 diff --git a/docs/architecture/2_development.md b/docs/_collections/_architecture/2_development.md similarity index 88% rename from docs/architecture/2_development.md rename to docs/_collections/_architecture/2_development.md index 6c16479..dd2b5cf 100644 --- a/docs/architecture/2_development.md +++ b/docs/_collections/_architecture/2_development.md @@ -1,5 +1,4 @@ --- -layout: default title: Development View parent: Architecture nav_order: 2 diff --git a/docs/architecture/3_process.md b/docs/_collections/_architecture/3_process.md similarity index 87% rename from docs/architecture/3_process.md rename to docs/_collections/_architecture/3_process.md index ff5f1f2..9ff64bd 100644 --- a/docs/architecture/3_process.md +++ b/docs/_collections/_architecture/3_process.md @@ -1,5 +1,4 @@ --- -layout: default title: Process View parent: Architecture nav_order: 3 diff --git a/docs/architecture/4_physical.md b/docs/_collections/_architecture/4_physical.md similarity index 93% rename from docs/architecture/4_physical.md rename to docs/_collections/_architecture/4_physical.md index 85a397d..7feabd0 100644 --- a/docs/architecture/4_physical.md +++ b/docs/_collections/_architecture/4_physical.md @@ -1,5 +1,4 @@ --- -layout: default title: Physical View parent: Architecture nav_order: 4 diff --git a/docs/architecture/5_scenarios.md b/docs/_collections/_architecture/5_scenarios.md similarity index 87% rename from docs/architecture/5_scenarios.md rename to docs/_collections/_architecture/5_scenarios.md index e13da2a..2ae8c5a 100644 --- a/docs/architecture/5_scenarios.md +++ b/docs/_collections/_architecture/5_scenarios.md @@ -1,5 +1,4 @@ --- -layout: default title: Scenarios parent: Architecture nav_order: 5 diff --git a/docs/architecture.md b/docs/_collections/_architecture/index.md similarity index 93% rename from docs/architecture.md rename to docs/_collections/_architecture/index.md index 346a3cb..c967ee7 100644 --- a/docs/architecture.md +++ b/docs/_collections/_architecture/index.md @@ -1,8 +1,8 @@ --- -layout: default title: Architecture nav_order: 4 has_children: true +permalink: /architecture --- ## Architecture @@ -31,7 +31,7 @@ standards: [NHS Architecture Principles][nhsap] | [Software Engineering Quality 4. provide context on which part of the system the diagram relates to -![img.png](architecture/assets/kruchten_4_1_model.png) +![img.png]({{ "/assets/architecture/kruchten_4_1_model.png" | relative_url }}) [Architectural Blueprints—The “4+1” View Model of Software Architecture][Kruchten] [Kruchten]: https://ics.uci.edu/~michele/Teaching/INF117/Krutchten%204+1View%20SWArch.pdf diff --git a/docs/architecture/physical/assets/Bounded_Context.drawio.png b/docs/_collections/_architecture/physical/assets/Bounded_Context.drawio.png similarity index 100% rename from docs/architecture/physical/assets/Bounded_Context.drawio.png rename to docs/_collections/_architecture/physical/assets/Bounded_Context.drawio.png diff --git a/docs/architecture/physical/assets/Domains.drawio.png b/docs/_collections/_architecture/physical/assets/Domains.drawio.png similarity index 100% rename from docs/architecture/physical/assets/Domains.drawio.png rename to docs/_collections/_architecture/physical/assets/Domains.drawio.png diff --git a/docs/architecture/physical/initial_account_structure_for_new_architecture.md b/docs/_collections/_architecture/physical/initial_account_structure_for_new_architecture.md similarity index 98% rename from docs/architecture/physical/initial_account_structure_for_new_architecture.md rename to docs/_collections/_architecture/physical/initial_account_structure_for_new_architecture.md index dd1ab2d..3ca65d1 100644 --- a/docs/architecture/physical/initial_account_structure_for_new_architecture.md +++ b/docs/_collections/_architecture/physical/initial_account_structure_for_new_architecture.md @@ -1,5 +1,5 @@ --- -layout: default + title: Initial account structure for new architecture parent: Physical View grand_parent: Architecture diff --git a/docs/architecture/physical/sub-domains_and_bounded_contexts.md b/docs/_collections/_architecture/physical/sub-domains_and_bounded_contexts.md similarity index 98% rename from docs/architecture/physical/sub-domains_and_bounded_contexts.md rename to docs/_collections/_architecture/physical/sub-domains_and_bounded_contexts.md index b19db10..19ead7f 100644 --- a/docs/architecture/physical/sub-domains_and_bounded_contexts.md +++ b/docs/_collections/_architecture/physical/sub-domains_and_bounded_contexts.md @@ -1,5 +1,5 @@ --- -layout: default + title: Sub-domains and bounded contexts parent: Physical View grand_parent: Architecture diff --git a/docs/developer-guides/Bash_and_Make.md b/docs/_collections/_guides/developer-guides/Bash_and_Make.md similarity index 99% rename from docs/developer-guides/Bash_and_Make.md rename to docs/_collections/_guides/developer-guides/Bash_and_Make.md index a2f7404..0ce5819 100644 --- a/docs/developer-guides/Bash_and_Make.md +++ b/docs/_collections/_guides/developer-guides/Bash_and_Make.md @@ -1,5 +1,5 @@ --- -layout: default + title: Bash and Make parent: Developer Guides --- diff --git a/docs/developer-guides/Scripting_Docker.md b/docs/_collections/_guides/developer-guides/Scripting_Docker.md similarity index 99% rename from docs/developer-guides/Scripting_Docker.md rename to docs/_collections/_guides/developer-guides/Scripting_Docker.md index 7474117..83ac501 100644 --- a/docs/developer-guides/Scripting_Docker.md +++ b/docs/_collections/_guides/developer-guides/Scripting_Docker.md @@ -1,5 +1,5 @@ --- -layout: default + title: Scripting Docker parent: Developer Guides --- diff --git a/docs/developer-guides/Scripting_Terraform.md b/docs/_collections/_guides/developer-guides/Scripting_Terraform.md similarity index 99% rename from docs/developer-guides/Scripting_Terraform.md rename to docs/_collections/_guides/developer-guides/Scripting_Terraform.md index 8a0dc78..6c7fc37 100644 --- a/docs/developer-guides/Scripting_Terraform.md +++ b/docs/_collections/_guides/developer-guides/Scripting_Terraform.md @@ -1,5 +1,5 @@ --- -layout: default + title: Scripting Terraform parent: Developer Guides --- diff --git a/docs/developer-guides/assets/make_help.png b/docs/_collections/_guides/developer-guides/assets/make_help.png similarity index 100% rename from docs/developer-guides/assets/make_help.png rename to docs/_collections/_guides/developer-guides/assets/make_help.png diff --git a/docs/dev-guides.md b/docs/_collections/_guides/developer-guides/dev-guides.md similarity index 71% rename from docs/dev-guides.md rename to docs/_collections/_guides/developer-guides/dev-guides.md index 58d5834..24a2d65 100644 --- a/docs/dev-guides.md +++ b/docs/_collections/_guides/developer-guides/dev-guides.md @@ -1,6 +1,7 @@ --- -layout: default + title: Developer Guides nav_order: 3 has_children: true +permalink: /dev-guides/ --- diff --git a/docs/user-guides/Perform_static_analysis.md b/docs/_collections/_guides/user-guides/Perform_static_analysis.md similarity index 99% rename from docs/user-guides/Perform_static_analysis.md rename to docs/_collections/_guides/user-guides/Perform_static_analysis.md index 7f9ef01..db200a8 100644 --- a/docs/user-guides/Perform_static_analysis.md +++ b/docs/_collections/_guides/user-guides/Perform_static_analysis.md @@ -1,5 +1,5 @@ --- -layout: default + title: Perform static analysis parent: User Guides --- diff --git a/docs/user-guides/Run_Git_hooks_on_commit.md b/docs/_collections/_guides/user-guides/Run_Git_hooks_on_commit.md similarity index 98% rename from docs/user-guides/Run_Git_hooks_on_commit.md rename to docs/_collections/_guides/user-guides/Run_Git_hooks_on_commit.md index 07c9569..3de2429 100644 --- a/docs/user-guides/Run_Git_hooks_on_commit.md +++ b/docs/_collections/_guides/user-guides/Run_Git_hooks_on_commit.md @@ -1,5 +1,5 @@ --- -layout: default + title: Run Git hooks on commit parent: User Guides --- diff --git a/docs/user-guides/Scan_dependencies.md b/docs/_collections/_guides/user-guides/Scan_dependencies.md similarity index 99% rename from docs/user-guides/Scan_dependencies.md rename to docs/_collections/_guides/user-guides/Scan_dependencies.md index 303fd82..8449cb6 100644 --- a/docs/user-guides/Scan_dependencies.md +++ b/docs/_collections/_guides/user-guides/Scan_dependencies.md @@ -1,5 +1,5 @@ --- -layout: default + title: Scan dependencies parent: User Guides --- diff --git a/docs/user-guides/Scan_secrets.md b/docs/_collections/_guides/user-guides/Scan_secrets.md similarity index 99% rename from docs/user-guides/Scan_secrets.md rename to docs/_collections/_guides/user-guides/Scan_secrets.md index 03c3659..4d7f7a0 100644 --- a/docs/user-guides/Scan_secrets.md +++ b/docs/_collections/_guides/user-guides/Scan_secrets.md @@ -1,5 +1,5 @@ --- -layout: default + title: Scan secrets parent: User Guides --- diff --git a/docs/user-guides/Sign_Git_commits.md b/docs/_collections/_guides/user-guides/Sign_Git_commits.md similarity index 99% rename from docs/user-guides/Sign_Git_commits.md rename to docs/_collections/_guides/user-guides/Sign_Git_commits.md index a627374..dd23712 100644 --- a/docs/user-guides/Sign_Git_commits.md +++ b/docs/_collections/_guides/user-guides/Sign_Git_commits.md @@ -1,5 +1,5 @@ --- -layout: default + title: Sign Git commits parent: User Guides --- diff --git a/docs/user-guides/Test_GitHub_Actions_locally.md b/docs/_collections/_guides/user-guides/Test_GitHub_Actions_locally.md similarity index 99% rename from docs/user-guides/Test_GitHub_Actions_locally.md rename to docs/_collections/_guides/user-guides/Test_GitHub_Actions_locally.md index 7bed68f..5243a78 100644 --- a/docs/user-guides/Test_GitHub_Actions_locally.md +++ b/docs/_collections/_guides/user-guides/Test_GitHub_Actions_locally.md @@ -1,5 +1,5 @@ --- -layout: default + title: Test GitHub Actions locally parent: User Guides --- diff --git a/docs/_collections/_guides/user-guides/drawio.md b/docs/_collections/_guides/user-guides/drawio.md new file mode 100644 index 0000000..f5e49bf --- /dev/null +++ b/docs/_collections/_guides/user-guides/drawio.md @@ -0,0 +1,15 @@ +--- + +title: Draw IO +parent: User Guides + +--- +## Using Draw io + +Reference a drawio file by: + +{{ "test.drawio" | relative_url }} + +{% drawio path="assets/userguides/test.drawio" page_number=0 height=400 %} + +[Something](test.drawio) diff --git a/docs/user-guides/mermaid-diagrams.md b/docs/_collections/_guides/user-guides/mermaid-diagrams.md similarity index 93% rename from docs/user-guides/mermaid-diagrams.md rename to docs/_collections/_guides/user-guides/mermaid-diagrams.md index 5058b37..a119d21 100644 --- a/docs/user-guides/mermaid-diagrams.md +++ b/docs/_collections/_guides/user-guides/mermaid-diagrams.md @@ -1,5 +1,5 @@ --- -layout: default + title: Mermaid Diagrams parent: User Guides --- diff --git a/docs/user-guides.md b/docs/_collections/_guides/user-guides/user-guides.md similarity index 65% rename from docs/user-guides.md rename to docs/_collections/_guides/user-guides/user-guides.md index 5a77b06..38c0ed9 100644 --- a/docs/user-guides.md +++ b/docs/_collections/_guides/user-guides/user-guides.md @@ -1,6 +1,7 @@ --- -layout: default + title: User Guides nav_order: 4 has_children: true +permalink: /user-guides-page/ --- diff --git a/docs/principles-and-practices/accelerate-dora.md b/docs/_collections/_principles/accelerate-dora.md similarity index 71% rename from docs/principles-and-practices/accelerate-dora.md rename to docs/_collections/_principles/accelerate-dora.md index fff5725..8a3a75b 100644 --- a/docs/principles-and-practices/accelerate-dora.md +++ b/docs/_collections/_principles/accelerate-dora.md @@ -1,14 +1,8 @@ --- -layout: page title: Accelerate. Devops. Dora. parent: Principles and Practices - description: About Accelerate. Devops. Dora. summary: About Accelerate. Devops. Dora. -is_not_draft: false last_modified_date: 2024-05-28 -owner: Ross Buggins -author: Ross Buggins - --- diff --git a/docs/principles-and-practices/domain-driven-design.md b/docs/_collections/_principles/domain-driven-design.md similarity index 72% rename from docs/principles-and-practices/domain-driven-design.md rename to docs/_collections/_principles/domain-driven-design.md index 7561570..efa9358 100644 --- a/docs/principles-and-practices/domain-driven-design.md +++ b/docs/_collections/_principles/domain-driven-design.md @@ -1,12 +1,7 @@ --- -layout: page title: Domain Driven Design parent: Principles and Practices description: About Strategic Domain Driven Design summary: About Strategic Domain Driven Design -is_not_draft: false last_modified_date: 2024-05-28 -owner: Ross Buggins -author: Ross Buggins - --- diff --git a/docs/goals.md b/docs/_collections/_principles/goals.md similarity index 93% rename from docs/goals.md rename to docs/_collections/_principles/goals.md index b83435a..0a77397 100644 --- a/docs/goals.md +++ b/docs/_collections/_principles/goals.md @@ -1,8 +1,7 @@ --- -layout: default title: Goals -nav_order: 5 -has_children: true +nav_order: 2 +permalink: /goals --- ## Development Goals diff --git a/docs/principles-and-practices/index.md b/docs/_collections/_principles/index.md similarity index 69% rename from docs/principles-and-practices/index.md rename to docs/_collections/_principles/index.md index 647b5eb..7def31d 100644 --- a/docs/principles-and-practices/index.md +++ b/docs/_collections/_principles/index.md @@ -1,14 +1,11 @@ --- -layout: page title: Principles and Practices description: About our principles and practices. summary: About our principles and practices. -nav_order: 6 +nav_order: 1 has_children: true -is_not_draft: false last_modified_date: 2024-05-28 -owner: Ross Buggins -author: Ross Buggins +permalink: /principles --- ## Architecture diff --git a/docs/principles-and-practices/micro-front-ends.md b/docs/_collections/_principles/micro-front-ends.md similarity index 68% rename from docs/principles-and-practices/micro-front-ends.md rename to docs/_collections/_principles/micro-front-ends.md index a5183e1..bbe90ec 100644 --- a/docs/principles-and-practices/micro-front-ends.md +++ b/docs/_collections/_principles/micro-front-ends.md @@ -1,12 +1,7 @@ --- -layout: page title: Micro Frontends parent: Principles and Practices description: About Micro Frontends summary: About Micro Frontends -is_not_draft: false last_modified_date: 2024-05-28 -owner: Ross Buggins -author: Ross Buggins - --- diff --git a/docs/principles-and-practices/team-topologies.md b/docs/_collections/_principles/team-topologies.md similarity index 68% rename from docs/principles-and-practices/team-topologies.md rename to docs/_collections/_principles/team-topologies.md index 7da3c7b..135bf1c 100644 --- a/docs/principles-and-practices/team-topologies.md +++ b/docs/_collections/_principles/team-topologies.md @@ -1,12 +1,7 @@ --- -layout: page title: Teams Topologies parent: Principles and Practices description: About Teams Topologies summary: About Teams Topologies -is_not_draft: false last_modified_date: 2024-05-28 -owner: Ross Buggins -author: Ross Buggins - --- diff --git a/docs/notify-repos.md b/docs/_collections/_repos/index.md similarity index 56% rename from docs/notify-repos.md rename to docs/_collections/_repos/index.md index 1914d9c..0a3725e 100644 --- a/docs/notify-repos.md +++ b/docs/_collections/_repos/index.md @@ -1,8 +1,10 @@ --- -layout: default + title: Repositories +order: 0 nav_order: 6 -has_children: false +has_children: true +permalink: /notify-repositories/ --- {% include notify-repo-table.html %} diff --git a/docs/_collections/_notify-repos/nhs-notify-dns.md b/docs/_collections/_repos/nhs-notify-dns.md similarity index 89% rename from docs/_collections/_notify-repos/nhs-notify-dns.md rename to docs/_collections/_repos/nhs-notify-dns.md index 1696f5b..508a743 100644 --- a/docs/_collections/_notify-repos/nhs-notify-dns.md +++ b/docs/_collections/_repos/nhs-notify-dns.md @@ -3,9 +3,9 @@ repo-name: nhs-notify-dns owners: ["rossbugginsnhs"] name: Notify Dns description: Notify DNS infrastructure -layout: notify-repo author: "Ross Buggins" order: 2 +parent: Repositories --- # Something diff --git a/docs/_collections/_notify-repos/nhs-notify-iam.md b/docs/_collections/_repos/nhs-notify-iam.md similarity index 89% rename from docs/_collections/_notify-repos/nhs-notify-iam.md rename to docs/_collections/_repos/nhs-notify-iam.md index 3465b99..60537a7 100644 --- a/docs/_collections/_notify-repos/nhs-notify-iam.md +++ b/docs/_collections/_repos/nhs-notify-iam.md @@ -3,9 +3,9 @@ repo-name: nhs-notify-iam owners: ["rossbugginsnhs"] name: Notify IAM description: Notify Identity and Access Management -layout: notify-repo author: "Ross Buggins" order: 3 +parent: Repositories --- # Something diff --git a/docs/_collections/_repos/nhs-notify-repository-template.md b/docs/_collections/_repos/nhs-notify-repository-template.md new file mode 100644 index 0000000..aa7b6ce --- /dev/null +++ b/docs/_collections/_repos/nhs-notify-repository-template.md @@ -0,0 +1,11 @@ +--- +repo-name: nhs-notify-repository-template +owners: ["rossbugginsnhs"] +name: Notify Repository Template +description: Notify Repository Template +author: "Ross Buggins" +order: 7 +parent: Repositories +--- + +# Something diff --git a/docs/_collections/_notify-repos/nhs-notify-web-cms.md b/docs/_collections/_repos/nhs-notify-web-cms.md similarity index 89% rename from docs/_collections/_notify-repos/nhs-notify-web-cms.md rename to docs/_collections/_repos/nhs-notify-web-cms.md index 1bf2d86..6ced2e4 100644 --- a/docs/_collections/_notify-repos/nhs-notify-web-cms.md +++ b/docs/_collections/_repos/nhs-notify-web-cms.md @@ -3,9 +3,9 @@ repo-name: nhs-notify-web-cms owners: ["rossbugginsnhs"] name: Notify Web CMS description: Notify Web CMS -layout: notify-repo author: "Ross Buggins" order: 4 +parent: Repositories --- # Something diff --git a/docs/_collections/_notify-repos/nhs-notify-web-platform.md b/docs/_collections/_repos/nhs-notify-web-platform.md similarity index 91% rename from docs/_collections/_notify-repos/nhs-notify-web-platform.md rename to docs/_collections/_repos/nhs-notify-web-platform.md index 78acf97..d6808af 100644 --- a/docs/_collections/_notify-repos/nhs-notify-web-platform.md +++ b/docs/_collections/_repos/nhs-notify-web-platform.md @@ -3,9 +3,9 @@ repo-name: nhs-notify-web-platform owners: ["rossbugginsnhs"] name: Notify Web Platform description: Notify Micro frontend web orchestration platform -layout: notify-repo author: "Ross Buggins" order: 5 +parent: Repositories --- # Something diff --git a/docs/_collections/_notify-repos/nhs-notify-web-template-management.md b/docs/_collections/_repos/nhs-notify-web-template-management.md similarity index 91% rename from docs/_collections/_notify-repos/nhs-notify-web-template-management.md rename to docs/_collections/_repos/nhs-notify-web-template-management.md index ea25eee..87430a7 100644 --- a/docs/_collections/_notify-repos/nhs-notify-web-template-management.md +++ b/docs/_collections/_repos/nhs-notify-web-template-management.md @@ -3,9 +3,9 @@ repo-name: nhs-notify-web-template-management owners: ["rossbugginsnhs"] name: Notify Web Template Management description: Notify Web Template Management Micro frontend -layout: notify-repo author: "Ross Buggins" order: 6 +parent: Repositories --- # Something diff --git a/docs/_collections/_notify-repos/nhs-notify.md b/docs/_collections/_repos/nhs-notify.md similarity index 85% rename from docs/_collections/_notify-repos/nhs-notify.md rename to docs/_collections/_repos/nhs-notify.md index cace9d0..728248a 100644 --- a/docs/_collections/_notify-repos/nhs-notify.md +++ b/docs/_collections/_repos/nhs-notify.md @@ -3,9 +3,9 @@ repo-name: nhs-notify owners: ["rossbugginsnhs"] name: NHS Core Developer Home description: The home for Notify Developers -layout: notify-repo author: "Ross Buggins" -order: 1 +order: 2 +parent: Repositories --- # Something diff --git a/docs/_config.yml b/docs/_config.yml index 4425a64..6dcf8cf 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -28,9 +28,92 @@ url: "https://nhsdigital.github.io" # the base hostname & protocol for your site collections_dir: _collections collections: - notify-repos: + repos: output: true sort_by: order + guides: + output: true + sort_by: order + adrs: + output: true + sort_by: order + architecture: + output: true + sort_by: order + principles: + output: true + sort_by: order + +defaults: + - scope: + path: "" + type: "repos" + values: + layout: "notify-repo" + is_not_draft: false + owner: NHS Notify + author: NHS Notify + last_modified_date: 2024-01-01 + - scope: + path: "" + type: "adrs" + values: + layout: "page" + is_not_draft: false + owner: NHS Notify + author: NHS Notify + last_modified_date: 2024-01-01 + - scope: + path: "" + type: "guides" + values: + layout: "page" + is_not_draft: false + owner: NHS Notify + author: NHS Notify + last_modified_date: 2024-01-01 + - scope: + path: "" + type: "principles" + values: + layout: "page" + is_not_draft: false + owner: NHS Notify + author: NHS Notify + last_modified_date: 2024-01-01 + - scope: + path: "" + type: "architecture" + values: + layout: "page" + is_not_draft: false + owner: NHS Notify + author: NHS Notify + last_modified_date: 2024-01-01 + +just_the_docs: + collections: + # Reference the "tests" collection + architecture: + name: Architecture + principles: + name: Principles and Practices + repos: + name: Notify Repositories + adrs: + name: Architectural Decisions + guides: + # Give the collection a name + name: Guides and How Tos + # Exclude the collection from the navigation + # Supports true or false (default) + nav_exclude: false + # Fold the collection in the navigation + # Supports true or false (default) + nav_fold: false # note: this option is new in v0.4 + # Exclude the collection from the search + # Supports true or false (defaul + search_exclude: false # Build settings theme: just-the-docs @@ -73,12 +156,10 @@ nav_external_links: hide_icon: false # set to true to hide the external link icon - defaults to false opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false - callouts: warning: title: Warning color: red - # Exclude from processing. # The following items will not be processed, by default. # Any item listed under the `exclude:` key here will be automatically added to diff --git a/docs/_includes/components/site_nav.html b/docs/_includes/components/site_nav.html new file mode 100644 index 0000000..ee6ef18 --- /dev/null +++ b/docs/_includes/components/site_nav.html @@ -0,0 +1,68 @@ +{%- comment -%} + Include as: {%- include_cached components/site_nav.html -%} + Depends on: site. + Results in: HTML for the site-nav. + Includes: + components/nav.html + Overwrites: + pages_top_size, collections_size, collection_entry, + collection_key, collection_value, collection. +{%- endcomment -%} + + diff --git a/docs/_includes/notify-repo-list.html b/docs/_includes/notify-repo-list.html index c2f8218..1e6acb1 100644 --- a/docs/_includes/notify-repo-list.html +++ b/docs/_includes/notify-repo-list.html @@ -1,11 +1,11 @@

Repository List

diff --git a/docs/_includes/notify-repo-table.html b/docs/_includes/notify-repo-table.html index aaa0efa..23503f5 100644 --- a/docs/_includes/notify-repo-table.html +++ b/docs/_includes/notify-repo-table.html @@ -5,14 +5,14 @@

Repository List

Repository Name More Info - {% for repo in site.notify-repos %} + {% for repo in site.repos %} {% if repo.order > 0 %} {{repo.repo-name}} - + {{ repo.name }} - {{ repo.description }} - {% endfor %} + {% endif %} {% endfor %} diff --git a/docs/_layouts/notify-repo.md b/docs/_layouts/notify-repo.md index 1b9cf0c..0bb04b9 100644 --- a/docs/_layouts/notify-repo.md +++ b/docs/_layouts/notify-repo.md @@ -1,12 +1,8 @@ --- -layout: default +layout: page --- -

{{page.name}} Repository

- -

-{{page.description}} -

+

https://github.com/NHSDigital/{{page.repo-name}} @@ -20,10 +16,10 @@ layout: default {% endfor %} -

{{ page.date }} - Written by {{ page.author }}

-

Content

{{ content }} {% include notify-repo-list.html %} + + diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html index 76206eb..7b94930 100644 --- a/docs/_layouts/page.html +++ b/docs/_layouts/page.html @@ -3,3 +3,5 @@ --- {% include page-info-header.html %} + +{{ content }} diff --git a/docs/architecture/assets/kruchten_4_1_model.png b/docs/assets/architecture/kruchten_4_1_model.png similarity index 100% rename from docs/architecture/assets/kruchten_4_1_model.png rename to docs/assets/architecture/kruchten_4_1_model.png diff --git a/docs/diagrams/.gitignore b/docs/assets/diagrams/.gitignore similarity index 100% rename from docs/diagrams/.gitignore rename to docs/assets/diagrams/.gitignore diff --git a/docs/diagrams/CD_Pipeline_Structure.drawio b/docs/assets/diagrams/CD_Pipeline_Structure.drawio similarity index 100% rename from docs/diagrams/CD_Pipeline_Structure.drawio rename to docs/assets/diagrams/CD_Pipeline_Structure.drawio diff --git a/docs/diagrams/CD_Pipeline_Structure.png b/docs/assets/diagrams/CD_Pipeline_Structure.png similarity index 100% rename from docs/diagrams/CD_Pipeline_Structure.png rename to docs/assets/diagrams/CD_Pipeline_Structure.png diff --git a/docs/diagrams/Repository_Template.drawio b/docs/assets/diagrams/Repository_Template.drawio similarity index 100% rename from docs/diagrams/Repository_Template.drawio rename to docs/assets/diagrams/Repository_Template.drawio diff --git a/docs/diagrams/Repository_Template_GitHub_Generic.png b/docs/assets/diagrams/Repository_Template_GitHub_Generic.png similarity index 100% rename from docs/diagrams/Repository_Template_GitHub_Generic.png rename to docs/assets/diagrams/Repository_Template_GitHub_Generic.png diff --git a/docs/user-guides/assets/test.drawio b/docs/assets/userguides/test.drawio similarity index 100% rename from docs/user-guides/assets/test.drawio rename to docs/assets/userguides/test.drawio diff --git a/docs/404.html b/docs/pages/404.html similarity index 100% rename from docs/404.html rename to docs/pages/404.html diff --git a/docs/index.md b/docs/pages/index.md similarity index 99% rename from docs/index.md rename to docs/pages/index.md index c77dafc..9f618ea 100644 --- a/docs/index.md +++ b/docs/pages/index.md @@ -5,6 +5,7 @@ layout: home title: Home nav_order: 1 +permalink: / --- [![CI/CD Pull Request](https://github.com/NHSDigital/nhs-notify/actions/workflows/jekyll-gh-pages.yml/badge.svg)](https://github.com/NHSDigital/nhs-notify/actions/workflows/jekyll-gh-pages.yml) diff --git a/docs/user-guides/drawio.md b/docs/user-guides/drawio.md deleted file mode 100644 index 4f806e0..0000000 --- a/docs/user-guides/drawio.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default -title: Draw IO -parent: User Guides - ---- -## Using Draw io - -Reference a drawio file by: - -{% raw %} - -```text -{% drawio path="./user-guides/assets/test.drawio" page_number=0 height=400 %} -``` - -{% endraw %} - -{% drawio path="./user-guides/assets/test.drawio" page_number=0 height=400 %} diff --git a/nhs-notify.code-workspace b/nhs-notify.code-workspace index ac775cd..ffe54d2 100644 --- a/nhs-notify.code-workspace +++ b/nhs-notify.code-workspace @@ -18,9 +18,18 @@ "MD033": false }, "cSpell.words": [ + "ADRS", + "Amaan", "Codespaces", - "endfor" - ] + "endfor", + "Nasar", + "preinstalled", + "pythonist", + "rossbugginsnhs", + "ruleset", + "Stefaniuk" + ], + "cSpell.language": "en-GB" }, "extensions": { "recommendations": [ diff --git a/scripts/config/vale/styles/Vocab/words/accept.txt b/scripts/config/vale/styles/Vocab/words/accept.txt index e1faaa7..8962b32 100644 --- a/scripts/config/vale/styles/Vocab/words/accept.txt +++ b/scripts/config/vale/styles/Vocab/words/accept.txt @@ -23,3 +23,4 @@ io drawio endraw [Oo]nboarding +relative_url