Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ccm 5329 template repo info #25

Merged
merged 4 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default

title: ADR-005
parent: ADRs
parent: Active ADRs
description: Documentation stored within repo
summary: Documentation stored within repo
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default

title: ADR-006
parent: ADRs
parent: Active ADRs
description: GitHub-hosted runners
summary: GitHub-hosted runners
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default

title: ADR-007
parent: ADRs
parent: Active ADRs
description: Naming Conventions
summary: Naming Conventions
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default

title: ADR-008
parent: ADRs
parent: Active ADRs
description: Programme wide public ADRS
summary: Programme wide public ADRS
---
Expand Down
5 changes: 3 additions & 2 deletions docs/adrs.md → docs/_collections/_adrs/adrs-active.md
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
layout: default
title: Logical View
parent: Architecture
nav_order: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
layout: default
title: Development View
parent: Architecture
nav_order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
layout: default
title: Process View
parent: Architecture
nav_order: 3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
layout: default
title: Physical View
parent: Architecture
nav_order: 4
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
layout: default
title: Scenarios
parent: Architecture
nav_order: 5
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: default
title: Architecture
nav_order: 4
has_children: true
permalink: /architecture
---

## Architecture
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Initial account structure for new architecture
parent: Physical View
grand_parent: Architecture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Sub-domains and bounded contexts
parent: Physical View
grand_parent: Architecture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Bash and Make
parent: Developer Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Scripting Docker
parent: Developer Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Scripting Terraform
parent: Developer Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default

title: Developer Guides
nav_order: 3
has_children: true
permalink: /dev-guides/
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Perform static analysis
parent: User Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Run Git hooks on commit
parent: User Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Scan dependencies
parent: User Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Scan secrets
parent: User Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Sign Git commits
parent: User Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Test GitHub Actions locally
parent: User Guides
---
Expand Down
15 changes: 15 additions & 0 deletions docs/_collections/_guides/user-guides/drawio.md
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default

title: Mermaid Diagrams
parent: User Guides
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default

title: User Guides
nav_order: 4
has_children: true
permalink: /user-guides-page/
---
Original file line number Diff line number Diff line change
@@ -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

---

Original file line number Diff line number Diff line change
@@ -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

---
5 changes: 2 additions & 3 deletions docs/goals.md → docs/_collections/_principles/goals.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
layout: default
title: Goals
nav_order: 5
has_children: true
nav_order: 2
permalink: /goals
---

## Development Goals
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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

---
Original file line number Diff line number Diff line change
@@ -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

---
6 changes: 4 additions & 2 deletions docs/notify-repos.md → docs/_collections/_repos/index.md
Original file line number Diff line number Diff line change
@@ -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 %}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions docs/_collections/_repos/nhs-notify-repository-template.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading