From 393a72808267d6af991fc01db51a8904579c184d Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 29 May 2024 13:56:18 +0100 Subject: [PATCH 1/6] Added launch files, custom header and practices pages. --- .vscode/launch.json | 11 +++ .vscode/tasks.json | 13 +++ README.md | 8 ++ docs/Makefile | 17 ++++ docs/_config.dev.yml | 3 + docs/_includes/.gitkeep | 0 docs/_includes/page-info-header.html | 80 +++++++++++++++++++ docs/_layouts/.gitkeep | 0 docs/_layouts/page.html | 5 ++ docs/package.json | 20 +++++ .../accelerate-dora.md | 14 ++++ .../domain-driven-design.md | 12 +++ docs/principles-and-practices/index.md | 14 ++++ .../team-topologies.md | 12 +++ 14 files changed, 209 insertions(+) create mode 100644 .vscode/launch.json create mode 100644 .vscode/tasks.json create mode 100644 docs/Makefile create mode 100644 docs/_config.dev.yml create mode 100644 docs/_includes/.gitkeep create mode 100644 docs/_includes/page-info-header.html create mode 100644 docs/_layouts/.gitkeep create mode 100644 docs/_layouts/page.html create mode 100644 docs/package.json create mode 100644 docs/principles-and-practices/accelerate-dora.md create mode 100644 docs/principles-and-practices/domain-driven-design.md create mode 100644 docs/principles-and-practices/index.md create mode 100644 docs/principles-and-practices/team-topologies.md diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..7a0ce95 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "node", + "request": "attach", + "name": "Attach", + "preLaunchTask": "jekyll" + } + ] +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..6d1b1b6 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,13 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "jekyll", + "options": { + "cwd": "${workspaceFolder}/docs/" + }, + "command": "make debug", + "type": "shell" + } + ] +} diff --git a/README.md b/README.md index 7eb4d8a..8fcc0ca 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # NHS Notify [Docs](docs/README.md) + +## Getting Started with local development + +```sh +cd docs +make install +make debug +``` diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..b4d072a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,17 @@ +default: install + +h help: + @egrep '^\S|^$$' Makefile + +install: + bundle config set --local path vendor/bundle + bundle install + +s serve: + bundle exec jekyll serve --trace --livereload + +build: + JEKYLL_ENV=production bundle exec jekyll build --trace + +debug: + npm run debug diff --git a/docs/_config.dev.yml b/docs/_config.dev.yml new file mode 100644 index 0000000..53d08cd --- /dev/null +++ b/docs/_config.dev.yml @@ -0,0 +1,3 @@ + +baseurl: "" # the subpath of your site, e.g. /blog +url: "" diff --git a/docs/_includes/.gitkeep b/docs/_includes/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/_includes/page-info-header.html b/docs/_includes/page-info-header.html new file mode 100644 index 0000000..68346ee --- /dev/null +++ b/docs/_includes/page-info-header.html @@ -0,0 +1,80 @@ +{% if page.is_not_draft %}{% else %} +{% assign is_draft = true %} +{% endif %} + +{% assign wordWarning = 200 %} {% assign wordCount = content | number_of_words%} +{% assign readTime = wordCount | divided_by: 100.0 | ceil %} + + + +{% if page.sub_title %} +

+ {{ page.title }} +

+

+ {{ page.summary }} +

+{% else %} +

+ {{ page.title }} +

+{% endif %} + + +
+

+ {% 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 site.gh_edit_repository and site.gh_edit_branch + and site.gh_edit_view_mode %} | + ๐Ÿงพ History + + {% endif %} +| +{% if page.author %} +โœ {{page.author}} +{% else %} +โœ Ross Buggins +{% endif %} +| +{% if page.owner %} +๐Ÿ”‘ {{page.owner}} +{% else %} +๐Ÿ”‘ Ross Buggins +{% endif %} +

+ +

{% for tag in page.tags %}{{tag}},{% endfor %}

+ +{% if wordCount < wordWarning %} +

๐Ÿšง This page has less that {{wordWarning}} words. So it looks like this page is still under construction.

+{% endif %} + + + +{% if page.description %} +

{{page.description}}

+{% endif %} + +{% if page.todo or is_draft %} +

Known Issues / Todo

+ + +{% endif %} +
+ + +
diff --git a/docs/_layouts/.gitkeep b/docs/_layouts/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html new file mode 100644 index 0000000..76206eb --- /dev/null +++ b/docs/_layouts/page.html @@ -0,0 +1,5 @@ +--- +layout: default +--- + +{% include page-info-header.html %} diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..785304f --- /dev/null +++ b/docs/package.json @@ -0,0 +1,20 @@ +{ + "name": "nhs-notify", + "version": "1.0.0", + "description": "", + "private": true, + "engines": { + }, + + "scripts": { + "debug": "JEKYLL_ENV=development BUNDLE_GEMFILE=Gemfile bundle exec jekyll serve --config _config.yml,_config.dev.yml --limit_posts 100 --trace --livereload" + + }, + "keywords": [], + "author": "", + "license": "ISC", + "devDependencies": { + }, + "dependencies": { + } +} diff --git a/docs/principles-and-practices/accelerate-dora.md b/docs/principles-and-practices/accelerate-dora.md new file mode 100644 index 0000000..fff5725 --- /dev/null +++ b/docs/principles-and-practices/accelerate-dora.md @@ -0,0 +1,14 @@ +--- +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/principles-and-practices/domain-driven-design.md new file mode 100644 index 0000000..7561570 --- /dev/null +++ b/docs/principles-and-practices/domain-driven-design.md @@ -0,0 +1,12 @@ +--- +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/principles-and-practices/index.md b/docs/principles-and-practices/index.md new file mode 100644 index 0000000..647b5eb --- /dev/null +++ b/docs/principles-and-practices/index.md @@ -0,0 +1,14 @@ +--- +layout: page +title: Principles and Practices +description: About our principles and practices. +summary: About our principles and practices. +nav_order: 6 +has_children: true +is_not_draft: false +last_modified_date: 2024-05-28 +owner: Ross Buggins +author: Ross Buggins +--- + +## Architecture diff --git a/docs/principles-and-practices/team-topologies.md b/docs/principles-and-practices/team-topologies.md new file mode 100644 index 0000000..7da3c7b --- /dev/null +++ b/docs/principles-and-practices/team-topologies.md @@ -0,0 +1,12 @@ +--- +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 + +--- From fdabf8a3ce21847d68a579e1048987b12f804a6a Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 29 May 2024 13:59:08 +0100 Subject: [PATCH 2/6] MFE page. --- docs/principles-and-practices/micro-front-ends.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/principles-and-practices/micro-front-ends.md diff --git a/docs/principles-and-practices/micro-front-ends.md b/docs/principles-and-practices/micro-front-ends.md new file mode 100644 index 0000000..a5183e1 --- /dev/null +++ b/docs/principles-and-practices/micro-front-ends.md @@ -0,0 +1,12 @@ +--- +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 + +--- From 99f247529e0e43a79c423b8c53a28e59344e4d8b Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 29 May 2024 16:28:51 +0100 Subject: [PATCH 3/6] Repo tables. --- docs/_includes/notify-repo-table.html | 19 +++++++++++++++++++ docs/_layouts/notify-repo.md | 6 ++++++ docs/notify-repos.md | 2 +- 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/_includes/notify-repo-table.html diff --git a/docs/_includes/notify-repo-table.html b/docs/_includes/notify-repo-table.html new file mode 100644 index 0000000..85d7fe3 --- /dev/null +++ b/docs/_includes/notify-repo-table.html @@ -0,0 +1,19 @@ +

Repository List

+ + + + + +{% for repo in site.notify-repos %} + + + + +{% endfor %} +
Repository NameMore Info
+ {{repo.repo-name}} + + + {{ repo.name }} - {{ repo.description }} + +
diff --git a/docs/_layouts/notify-repo.md b/docs/_layouts/notify-repo.md index 47d9db8..1b9cf0c 100644 --- a/docs/_layouts/notify-repo.md +++ b/docs/_layouts/notify-repo.md @@ -4,7 +4,13 @@ layout: default

{{page.name}} Repository

+

{{page.description}} +

+ +

+https://github.com/NHSDigital/{{page.repo-name}} +

Authors

diff --git a/docs/notify-repos.md b/docs/notify-repos.md index 89c847b..1914d9c 100644 --- a/docs/notify-repos.md +++ b/docs/notify-repos.md @@ -5,4 +5,4 @@ nav_order: 6 has_children: false --- -{% include notify-repo-list.html %} +{% include notify-repo-table.html %} From a648b9fb6b21f0ef1761bc42f96d4cf57643a612 Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 29 May 2024 16:34:01 +0100 Subject: [PATCH 4/6] html formatting. --- docs/_includes/notify-repo-table.html | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/_includes/notify-repo-table.html b/docs/_includes/notify-repo-table.html index 85d7fe3..aaa0efa 100644 --- a/docs/_includes/notify-repo-table.html +++ b/docs/_includes/notify-repo-table.html @@ -2,18 +2,17 @@

Repository List

- - -{% for repo in site.notify-repos %} + + + + {% for repo in site.notify-repos %} - + + {{ repo.name }} - {{ repo.description }} + + -{% endfor %} + {% endfor %}
Repository NameMore Info
Repository NameMore Info
- {{repo.repo-name}} - {{repo.repo-name}} - {{ repo.name }} - {{ repo.description }} - -
From a3514c9c9638202ba5e952bb89177fd529156b11 Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 29 May 2024 20:20:19 +0100 Subject: [PATCH 5/6] info header spacing formatting. --- docs/_includes/page-info-header.html | 108 +++++++++++---------------- 1 file changed, 43 insertions(+), 65 deletions(-) diff --git a/docs/_includes/page-info-header.html b/docs/_includes/page-info-header.html index 68346ee..a83edfa 100644 --- a/docs/_includes/page-info-header.html +++ b/docs/_includes/page-info-header.html @@ -1,80 +1,58 @@ -{% if page.is_not_draft %}{% else %} -{% assign is_draft = true %} -{% endif %} - -{% assign wordWarning = 200 %} {% assign wordCount = content | number_of_words%} -{% assign readTime = wordCount | divided_by: 100.0 | ceil %} - - - -{% if page.sub_title %} -

- {{ page.title }} -

-

- {{ page.summary }} -

+{% if page.is_not_draft %}{% else %} {% assign is_draft = true %} {% endif %} {% +assign wordWarning = 200 %} {% assign wordCount = content | number_of_words%} {% +assign readTime = wordCount | divided_by: 100.0 | ceil %} {% if page.sub_title +%} +

{{ page.title }}

+

{{ page.summary }}

{% else %} -

- {{ page.title }} -

+

{{ page.title }}

{% endif %} -

- {% 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 site.gh_edit_repository and site.gh_edit_branch - and site.gh_edit_view_mode %} | + {% 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 + site.gh_edit_repository and site.gh_edit_branch and site.gh_edit_view_mode + %} | ๐Ÿงพ History - {% endif %} -| -{% if page.author %} -โœ {{page.author}} -{% else %} -โœ Ross Buggins -{% endif %} -| -{% if page.owner %} -๐Ÿ”‘ {{page.owner}} -{% else %} -๐Ÿ”‘ Ross Buggins -{% endif %} -

- -

{% for tag in page.tags %}{{tag}},{% endfor %}

- -{% if wordCount < wordWarning %} -

๐Ÿšง This page has less that {{wordWarning}} words. So it looks like this page is still under construction.

-{% endif %} - - - -{% if page.description %} -

{{page.description}}

-{% endif %} + {% endif %} | {% if page.author %} โœ {{page.author}} {% else %} โœ Ross + Buggins {% endif %} | {% if page.owner %} ๐Ÿ”‘ {{page.owner}} {% else %} ๐Ÿ”‘ + Ross Buggins {% endif %} +

-{% if page.todo or is_draft %} -

Known Issues / Todo

+

+ {% for tag in page.tags %}{{tag}},{% endfor %} +

-
    - {% if page.is_not_draft %}{% else %}
  • โ›… This page is draft and is subject to rapid change, and may not be fully accurate or complete
    • {% endif %} - {% for todo in page.todo %}
  • {{todo}}
    • {% endfor %} -
-{% endif %} + {% if wordCount < wordWarning %} +

+ ๐Ÿšง This page has less that {{wordWarning}} words. So it looks like this page + is still under construction. +

+ {% endif %} {% if page.description %} +

{{page.description}}

+ {% endif %} {% if page.todo or is_draft %} +

Known Issues / Todo

+ +
    + {% if page.is_not_draft %}{% else %} +
  • + โ›… This page is draft and is subject to rapid change, and may not + be fully accurate or complete +
    • + {% endif %} {% for todo in page.todo %} +
  • {{todo}}
    • + {% endfor %} +
+ {% endif %}
- -
+
From 3886a4c460be3c6bf68089614fd090c61fd3ed0a Mon Sep 17 00:00:00 2001 From: Ross Buggins Date: Wed, 29 May 2024 20:30:53 +0100 Subject: [PATCH 6/6] Gemfile line indents. --- docs/.gitignore | 2 +- docs/Gemfile.lock | 107 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 108 insertions(+), 1 deletion(-) create mode 100644 docs/Gemfile.lock diff --git a/docs/.gitignore b/docs/.gitignore index 918de83..53d4e42 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -3,4 +3,4 @@ _site .jekyll-cache .jekyll-metadata vendor -Gemfile.lock +#Gemfile.lock diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 0000000..bb1714e --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,107 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.6) + public_suffix (>= 2.0.2, < 6.0) + cgi (0.4.1) + colorator (1.1.0) + concurrent-ruby (1.2.3) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + erb (4.0.4) + cgi (>= 0.3.3) + eventmachine (1.2.7) + ffi (1.16.3) + forwardable-extended (2.6.0) + google-protobuf (3.25.3-x86_64-linux) + http_parser.rb (0.8.0) + i18n (1.14.5) + concurrent-ruby (~> 1.0) + jekyll (4.3.3) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (>= 0.3.6, < 0.5) + pathutil (~> 0.9) + rouge (>= 3.0, < 5.0) + safe_yaml (~> 1.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-drawio (1.1.1) + erb (>= 2.2, < 5.0) + jekyll (~> 4.3) + nokogiri (~> 1.12) + jekyll-feed (0.17.0) + jekyll (>= 3.7, < 5.0) + jekyll-include-cache (0.2.1) + jekyll (>= 3.7, < 5.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + just-the-docs (0.8.2) + jekyll (>= 3.8.5) + jekyll-include-cache + jekyll-seo-tag (>= 2.0) + rake (>= 12.3.1) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + nokogiri (1.16.5-x86_64-linux) + racc (~> 1.4) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (5.0.5) + racc (1.8.0) + rake (13.2.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rexml (3.2.8) + strscan (>= 3.0.9) + rouge (4.2.1) + safe_yaml (1.0.5) + sass-embedded (1.69.5) + google-protobuf (~> 3.23) + rake (>= 13.0.0) + strscan (3.1.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.5.0) + webrick (1.8.1) + +PLATFORMS + x86_64-linux + +DEPENDENCIES + http_parser.rb (~> 0.6.0) + jekyll (~> 4.3.3) + jekyll-drawio + jekyll-feed (~> 0.12) + just-the-docs + minima (~> 2.5) + tzinfo (>= 1, < 3) + tzinfo-data + wdm (~> 0.1.1) + +BUNDLED WITH + 2.5.10