Skip to content

Commit d0e19ab

Browse files
RossBugginsNHSRossBugginsNHS
committed
Added launch files, custom header and practices pages.
1 parent 8bb3ff6 commit d0e19ab

14 files changed

+209
-0
lines changed

‎.vscode/launch.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"type": "node",
6+
"request": "attach",
7+
"name": "Attach",
8+
"preLaunchTask": "jekyll"
9+
}
10+
]
11+
}

‎.vscode/tasks.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "jekyll",
6+
"options": {
7+
"cwd": "${workspaceFolder}/docs/"
8+
},
9+
"command": "make debug",
10+
"type": "shell"
11+
}
12+
]
13+
}

‎README.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# NHS Notify
22

33
[Docs](docs/README.md)
4+
5+
## Getting Started with local development
6+
7+
```sh
8+
cd docs
9+
make install
10+
make debug
11+
```

‎docs/Makefile

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
default: install
2+
3+
h help:
4+
@egrep '^\S|^$$' Makefile
5+
6+
install:
7+
bundle config set --local path vendor/bundle
8+
bundle install
9+
10+
s serve:
11+
bundle exec jekyll serve --trace --livereload
12+
13+
build:
14+
JEKYLL_ENV=production bundle exec jekyll build --trace
15+
16+
debug:
17+
npm run debug

‎docs/_config.dev.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
baseurl: "" # the subpath of your site, e.g. /blog
3+
url: ""

‎docs/_includes/.gitkeep

Whitespace-only changes.

‎docs/_includes/page-info-header.html

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
{% if page.is_not_draft %}{% else %}
2+
{% assign is_draft = true %}
3+
{% endif %}
4+
5+
{% assign wordWarning = 200 %} {% assign wordCount = content | number_of_words%}
6+
{% assign readTime = wordCount | divided_by: 100.0 | ceil %}
7+
8+
9+
10+
{% if page.sub_title %}
11+
<h1>
12+
{{ page.title }}
13+
</h1>
14+
<p class="text-medium text-grey-dk-250 mb-0">
15+
{{ page.summary }}
16+
</p>
17+
{% else %}
18+
<h1>
19+
{{ page.title }}
20+
</h1>
21+
{% endif %}
22+
23+
24+
<div class="page-info">
25+
<p class="text-small text-grey-dk-000 mb-0">
26+
{% if page.last_modified_date %}
27+
{{ page.last_modified_date | date: "%Y-%m-%d"}} |
28+
{% else %}
29+
2022-07-01 |
30+
{% endif %}
31+
32+
📑 {{ wordCount }} words | ⏱ {{readTime}} mins
33+
{% if site.gh_edit_link and
34+
site.gh_edit_link_text and site.gh_edit_repository and site.gh_edit_branch
35+
and site.gh_edit_view_mode %} |
36+
<a
37+
href="{{ site.gh_edit_repository }}/commits/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}"
38+
id="edit-this-page"
39+
>🧾 History</a
40+
>
41+
42+
{% endif %}
43+
|
44+
{% if page.author %}
45+
✍ {{page.author}}
46+
{% else %}
47+
✍ Ross Buggins
48+
{% endif %}
49+
|
50+
{% if page.owner %}
51+
🔑 {{page.owner}}
52+
{% else %}
53+
🔑 Ross Buggins
54+
{% endif %}
55+
</p>
56+
57+
<p class="text-small text-grey-dk-000 mb-0">{% for tag in page.tags %}<a class="text-small" href="/tags/{{tag}}.html">{{tag}}</a>,{% endfor %}</p>
58+
59+
{% if wordCount < wordWarning %}
60+
<p class="text-small text-grey-dk-000 mb-0">🚧 This page has less that {{wordWarning}} words. So it looks like this page is still under construction.</p>
61+
{% endif %}
62+
63+
64+
65+
{% if page.description %}
66+
<p class="text-nhs-mid-grey mb-0"><i>{{page.description}}</i></p>
67+
{% endif %}
68+
69+
{% if page.todo or is_draft %}
70+
<p class="text-small text-nhs-mid-grey mb-0"><b>Known Issues / Todo</b></p>
71+
72+
<ul>
73+
{% if page.is_not_draft %}{% else %}<li class="text-small text-nhs-mid-grey mb-0">⛅ <b>This page is draft</b> and is subject to rapid change, and may not be fully accurate or complete</li>{% endif %}
74+
{% for todo in page.todo %}<li class="text-small text-nhs-mid-grey mb-0">{{todo}}</li>{% endfor %}
75+
</ul>
76+
{% endif %}
77+
</div>
78+
79+
80+
<hr/>

‎docs/_layouts/.gitkeep

Whitespace-only changes.

‎docs/_layouts/page.html

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: default
3+
---
4+
5+
{% include page-info-header.html %}

‎docs/package.json

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "nhs-notify",
3+
"version": "1.0.0",
4+
"description": "",
5+
"private": true,
6+
"engines": {
7+
},
8+
9+
"scripts": {
10+
"debug": "JEKYLL_ENV=development BUNDLE_GEMFILE=Gemfile bundle exec jekyll serve --config _config.yml,_config.dev.yml --limit_posts 100 --trace --livereload"
11+
12+
},
13+
"keywords": [],
14+
"author": "",
15+
"license": "ISC",
16+
"devDependencies": {
17+
},
18+
"dependencies": {
19+
}
20+
}

‎docs/principles-and-practices/accelerate-dora.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: page
3+
title: Accelerate. Devops. Dora.
4+
parent: Principles and Practices
5+
6+
description: About Accelerate. Devops. Dora.
7+
summary: About Accelerate. Devops. Dora.
8+
is_not_draft: false
9+
last_modified_date: 2024-05-28
10+
owner: Ross Buggins
11+
author: Ross Buggins
12+
13+
---
14+

‎docs/principles-and-practices/domain-driven-design.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: page
3+
title: Domain Driven Design
4+
parent: Principles and Practices
5+
description: About Strategic Domain Driven Design
6+
summary: About Strategic Domain Driven Design
7+
is_not_draft: false
8+
last_modified_date: 2024-05-28
9+
owner: Ross Buggins
10+
author: Ross Buggins
11+
12+
---

‎docs/principles-and-practices/index.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: page
3+
title: Principles and Practices
4+
description: About our principles and practices.
5+
summary: About our principles and practices.
6+
nav_order: 6
7+
has_children: true
8+
is_not_draft: false
9+
last_modified_date: 2024-05-28
10+
owner: Ross Buggins
11+
author: Ross Buggins
12+
---
13+
14+
## Architecture

‎docs/principles-and-practices/team-topologies.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: page
3+
title: Teams Topologies
4+
parent: Principles and Practices
5+
description: About Teams Topologies
6+
summary: About Teams Topologies
7+
is_not_draft: false
8+
last_modified_date: 2024-05-28
9+
owner: Ross Buggins
10+
author: Ross Buggins
11+
12+
---

0 commit comments

Comments
 (0)