Skip to content

Commit

Permalink
Merge pull request #28 from RossBugginsNHS/main
Browse files Browse the repository at this point in the history
nhs formatting
  • Loading branch information
RossBugginsNHS authored May 31, 2024
2 parents d349a6d + f7a2f87 commit 05962d5
Show file tree
Hide file tree
Showing 20 changed files with 186 additions and 86 deletions.
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ just_the_docs:
collections:
# Reference the "tests" collection
architecture:
name: Architecture
name: Architectural Design
principles:
name: Principles and Practices
repos:
Expand Down
18 changes: 8 additions & 10 deletions docs/_includes/page-info-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
assign readTime = wordCount | divided_by: 100.0 | ceil %} {% if page.sub_title
%}
<h1>{{ page.title }}</h1>
<p class="text-medium text-grey-dk-250 mb-0">{{ page.summary }}</p>
<p class="text-medium text-grey-dk-300 mb-0">{{ page.summary }}</p>
{% else %}
<h1>{{ page.title }}</h1>
{% endif %}

<div class="page-info">
<p class="text-small text-grey-dk-000 mb-0">
<p class="text-small text-grey-dk-300 mb-0">
{% if page.last_modified_date %} {{ page.last_modified_date | date:
"%Y-%m-%d"}} | {% else %} 2022-07-01 | {% endif %} 📑 {{ wordCount }} words
| ⏱ {{readTime}} mins {% if site.gh_edit_link and site.gh_edit_link_text and
Expand All @@ -26,33 +26,31 @@ <h1>{{ page.title }}</h1>
Ross Buggins {% endif %}
</p>

<p class="text-small text-grey-dk-000 mb-0">
<p class="text-small text-grey-dk-300 mb-0">
{% for tag in page.tags %}<a class="text-small" href="/tags/{{tag}}.html"
>{{tag}}</a
>,{% endfor %}
</p>

{% if wordCount < wordWarning %}
<p class="text-small text-grey-dk-000 mb-0">
<p class="text-small text-grey-dk-300 mb-0">
🚧 This page has less that {{wordWarning}} words. So it looks like this page
is still under construction.
</p>
{% endif %} {% if page.description %}
<p class="text-nhs-mid-grey mb-0"><i>{{page.description}}</i></p>
<p class="text-grey-dk-300 mb-0"><i>{{page.description}}</i></p>
{% endif %} {% if page.todo or is_draft %}
<p class="text-small text-nhs-mid-grey mb-0"><b>Known Issues / Todo</b></p>
<p class="text-small text-grey-dk-300 mb-0"><b>Known Issues / Todo</b></p>

<ul>
{% if page.is_not_draft %}{% else %}
<li class="text-small text-nhs-mid-grey mb-0">
<li class="text-small text-grey-dk-300 mb-0">
<b>This page is draft</b> and is subject to rapid change, and may not
be fully accurate or complete
</li>
{% endif %} {% for todo in page.todo %}
<li class="text-small text-nhs-mid-grey mb-0">{{todo}}</li>
<li class="text-small text-grey-dk-300 mb-0">{{todo}}</li>
{% endfor %}
</ul>
{% endif %}
</div>

<hr />
47 changes: 47 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: table_wrappers
---

<!DOCTYPE html>

<html lang="{{ site.lang | default: 'en-US' }}">
{% include head.html %}
<body>
<a class="skip-to-main" href="#main-content">Skip to main content</a>
{% include icons/icons.html %}
{% if page.nav_enabled == true %}
{% include components/sidebar.html %}
{% elsif layout.nav_enabled == true and page.nav_enabled == nil %}
{% include components/sidebar.html %}
{% elsif site.nav_enabled != false and layout.nav_enabled == nil and page.nav_enabled == nil %}
{% include components/sidebar.html %}
{% endif %}
<div class="main" id="top">
{% include components/header.html %}
<div class="main-content-wrap">
{% include components/breadcrumbs.html %}
<div id="main-content" class="main-content">
<main>
{% if site.heading_anchors != false %}
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
{% else %}
{{ content }}
{% endif %}

{% if page.has_children == true and page.has_toc != false %}
{% include components/children_nav.html %}
{% endif %}
</main>
{% include components/footer.html %}
</div>
</div>
{% if site.search_enabled != false %}
{% include components/search_footer.html %}
{% endif %}
</div>

{% if site.mermaid %}
{% include components/mermaid.html %}
{% endif %}
</body>
</html>
5 changes: 5 additions & 0 deletions docs/_layouts/home.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: default
---

{{ content }}
25 changes: 22 additions & 3 deletions docs/_sass/color_schemes/nhs.scss
Original file line number Diff line number Diff line change
@@ -1,18 +1,37 @@
@import "./color_schemes/light";


@font-face {
font-family: "Frutiger W01";
font-style: normal;
src: url("https://assets.nhs.uk/fonts/FrutigerLTW01-55Roman.woff2") format('woff2');
}

@font-face {
font-family: "Frutiger W01";
font-weight: 800;
font-style: normal;
src: url("https://assets.nhs.uk/fonts/FrutigerLTW01-65Bold.woff2") format('woff2');
}


// Typography

// prettier-ignore
$body-font-family: "Frutiger W01", Arial, Sans-serif;
$mono-font-family: "Frutiger W01", Arial, Sans-serif;
$body-font-family: Frutiger W01,Arial,Sans-serif;
$mono-font-family: Frutiger W01,Arial,Sans-serif;



$blue-000: #005eb8;
$grey-dk-000: #d8dde0;
$grey-dk-100: #f0f4f5;
$sidebar-color: $grey-dk-000;
$grey-dk-300: #212B32;
$sidebar-color: $grey-dk-100;
$body-background-color: $grey-dk-100;
$link-color: $blue-000;

$font-size-7: 1.25rem;
$font-size-6: 2rem;
$font-size-8: 3rem;
//$font-size-5: 1.188rem; // h3
49 changes: 49 additions & 0 deletions docs/_sass/custom/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Totally custom here.

.nav-category {
text-transform:none;
color: $grey-dk-300;
@include fs-4;
font-weight: 600;
}

.site-title{
font-weight: 600;
font-size: 1.2rem !important;
}

.nav-list {
.nav-list-item {
@include fs-4;
font-weight: 400;
-webkit-font-smoothing:antialiased;
}
}

body {
color: $grey-dk-300;
font-size: 1.2rem !important;
//line-height: 28px;
//@include fs-5;
}

@media (min-width: 31.25rem) {
h1, .text-alpha {
font-size: 3rem !important;
font-weight: 600;
}
}

@media (min-width: 31.25rem) {
h2, .text-alpha {
font-size: 2rem !important;
font-weight: 600;
}
}

@media (min-width: 31.25rem) {
h3, .text-alpha {
font-size: 1.5rem !important;
font-weight: 600;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Use git hook and GitHub Action to check the .editorconfig complianc
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` |
Expand All @@ -15,7 +13,6 @@ summary: Use git hook and GitHub Action to check the .editorconfig compliance
> | 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)
- [Decision](#decision)
- [Assumptions](#assumptions)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
---

title: ADR-002
parent: Active ADRs
description: Scan repository for hard-coded secrets
summary: Scan repository for hard-coded secrets
---

## ADR-002: Scan repository for hard-coded secrets

>| | |
>| ------------ | ------------------------------------------------------------- |
>| Date | `05/06/2023` |
>| Status | `RFC` |
>| Deciders | `Engineering` |
>| Significance | `Construction techniques` |
>| Owners | `Dan Stefaniuk, Jon Pearce, Tamara Goldschmidt, Tim Rickwood` |
> | | |
> | ------------ | ------------------------------------------------------------- |
> | Date | `05/06/2023` |
> | Status | `RFC` |
> | Deciders | `Engineering` |
> | Significance | `Construction techniques` |
> | Owners | `Dan Stefaniuk, Jon Pearce, Tamara Goldschmidt, Tim Rickwood` |
---

- [ADR-002: Scan repository for hard-coded secrets](#adr-002-scan-repository-for-hard-coded-secrets)
- [Context](#context)
- [Decision](#decision)
- [Assumptions](#assumptions)
Expand Down Expand Up @@ -61,6 +57,7 @@ There are three options presented in this decision record.
- Implementation technologies: **Shell script**
- Licence: **[Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)**
- Features

- [x] Scan whole history
- [x] Scan single commit
- [ ] Predefined set of rules: _A very limited number of rules_
Expand All @@ -87,6 +84,7 @@ There are three options presented in this decision record.
- Implementation technologies: **Go language**
- Licence: **[AGPL-3.0](https://choosealicense.com/licenses/agpl-3.0/)**
- Features

- [x] Scan whole history
- [x] Scan single commit
- [ ] Predefined set of rules
Expand All @@ -112,7 +110,9 @@ There are three options presented in this decision record.
- Number of Stars & Forks: **13k & 1.2k**
- Implementation technologies: **Go language**
- Licence: **[MIT](https://choosealicense.com/licenses/mit/)**

- Features

- [x] Scan whole history
- [x] Scan single commit
- [x] Predefined set of rules
Expand All @@ -134,7 +134,7 @@ The decision is to support Option 3 and endorse the usage of the `gitleaks` tool

### Rationale

This decision was made with the understanding that the chosen tool must support the NHS England [Coding in the Open](https://github.com/nhsx/open-source-policy) initiative/policy and also be compatible with usage in private repositories.
This decision was made with the understanding that the chosen tool must support the NHS England [Coding in the Open](https://github.com/nhsx/open-source-policy) initiative/policy and also be compatible with usage in private repositories.

## Consequences

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Acceptable use of GitHub authentication and authorisation mechanism
summary: Acceptable use of GitHub authentication and authorisation mechanisms
---

## ADR-003: Acceptable use of GitHub authentication and authorisation mechanisms

> | | |
> | ------------ | -------------------------------------------- |
> | Date | `04/09/2023` |
Expand All @@ -17,7 +15,6 @@ summary: Acceptable use of GitHub authentication and authorisation mechanisms
---

- [ADR-003: Acceptable use of GitHub authentication and authorisation mechanisms](#adr-003-acceptable-use-of-github-authentication-and-authorisation-mechanisms)
- [Context](#context)
- [Decision](#decision)
- [Assumptions](#assumptions)
Expand Down
3 changes: 0 additions & 3 deletions docs/collections/_adrs/adr-004-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@ description: GitHub as default git upstream location
summary: GitHub as default git upstream location
---

## ADR-004: GitHub as default git upstream location

| | |
| ------------ | -------------- |
| Date | `2024-05-22` |
| Status | `Decided` |
| Deciders | `Engineering` |
| 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)
Expand Down
4 changes: 0 additions & 4 deletions docs/collections/_adrs/adr-005-git-docs.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
---

title: ADR-005
parent: Active ADRs
description: Documentation stored within repo
summary: Documentation stored within repo
---

## ADR-005: Documentation stored within repo

| | |
| ------------ | -------------- |
| Date | `2024-05-22` |
| Status | `Decided` |
| Deciders | `Engineering` |
| Significance | `Ross Buggins` |

- [ADR-005: Documentation stored within repo](#adr-005-documentation-stored-within-repo)
- [Decision](#decision)

## Decision
Expand Down
4 changes: 0 additions & 4 deletions docs/collections/_adrs/adr-006-github-hosted-runners.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
---

title: ADR-006
parent: Active ADRs
description: GitHub-hosted runners
summary: GitHub-hosted runners
---

## ADR-006: GitHub-hosted runners

| | |
| ------------ | -------------- |
| Date | `2024-05-22` |
| Status | `Decided` |
| Deciders | `Engineering` |
| Significance | `Ross Buggins` |

- [ADR-006: GitHub-hosted runners](#adr-006-github-hosted-runners)
- [Decision](#decision)

## Decision
Expand Down
3 changes: 0 additions & 3 deletions docs/collections/_adrs/adr-007-naming-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@ description: Naming Conventions
summary: Naming Conventions
---

## ADR-007: Naming Conventions

| | |
| ------------ | -------------- |
| Date | `2024-05-22` |
| Status | `Decided` |
| Deciders | `Engineering` |
| Significance | `Ross Buggins` |

- [ADR-007: Naming Conventions](#adr-007-naming-conventions)
- [Decision](#decision)

## Decision
Expand Down
Loading

0 comments on commit 05962d5

Please sign in to comment.