Merge pull request #20 from NHSDigital/CCM-5298-principles-and-practises

Added launch files, custom header and practices pages.

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach",
+      "preLaunchTask": "jekyll"
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "jekyll",
+      "options": {
+        "cwd": "${workspaceFolder}/docs/"
+    },
+      "command": "make debug",
+      "type": "shell"
+    }
+  ]
+}

README.md

@@ -1,3 +1,11 @@
 # NHS Notify
 
 [Docs](docs/README.md)
+
+## Getting Started with local development
+
+```sh
+cd docs
+make install
+make debug
+```

docs/.gitignore

@@ -3,4 +3,4 @@ _site
 .jekyll-cache
 .jekyll-metadata
 vendor
-Gemfile.lock
+#Gemfile.lock

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

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

docs/_config.dev.yml

@@ -0,0 +1,3 @@
+
+baseurl: "" # the subpath of your site, e.g. /blog
+url: ""

docs/_includes/notify-repo-table.html

@@ -0,0 +1,18 @@
+<h2>Repository List</h2>
+
+<table>
+  <tr>
+    <th>Repository Name</th>
+    <th>More Info</th>
+  </tr>
+  {% for repo in site.notify-repos %}
+  <tr>
+    <td>{{repo.repo-name}}</td>
+    <td>
+      <a href="{{site.baseurl}}/notify-repos/{{repo.repo-name}}.html">
+        {{ repo.name }} - {{ repo.description }}
+      </a>
+    </td>
+  </tr>
+  {% endfor %}
+</table>

docs/_includes/page-info-header.html

@@ -0,0 +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
+%}
+<h1>{{ page.title }}</h1>
+<p class="text-medium text-grey-dk-250 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">
+    {% 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
+    %} |
+    <a
+      href="{{ site.gh_edit_repository }}/commits/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}"
+      id="edit-this-page"
+      >🧾 History</a
+    >
+
+    {% endif %} | {% if page.author %} ✍ {{page.author}} {% else %} ✍ Ross
+    Buggins {% endif %} | {% if page.owner %} 🔑 {{page.owner}} {% else %} 🔑
+    Ross Buggins {% endif %}
+  </p>
+
+  <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>
+
+  {% if wordCount < wordWarning %}
+  <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>
+  {% endif %} {% if page.description %}
+  <p class="text-nhs-mid-grey 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>
+
+  <ul>
+    {% 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 %} {% for todo in page.todo %}
+    <li class="text-small text-nhs-mid-grey mb-0">{{todo}}</li>
+    {% endfor %}
+  </ul>
+  {% endif %}
+</div>
+
+<hr />

docs/_layouts/notify-repo.md

@@ -4,7 +4,13 @@ layout: default
 
 <h1>{{page.name}} Repository</h1>
 
+<p>
 {{page.description}}
+</p>
+
+<p>
+<a href="https://github.com/NHSDigital/{{page.repo-name}}">https://github.com/NHSDigital/{{page.repo-name}}</a>
+</p>
 
 <h2>Authors</h2>
 

docs/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{% include page-info-header.html %}

docs/notify-repos.md

@@ -5,4 +5,4 @@ nav_order: 6
 has_children: false
 ---
 
-{% include notify-repo-list.html %}
+{% include notify-repo-table.html %}

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": {
+  }
+}

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
+
+---
+

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
+
+---

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

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
+
+---

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
+
+---