initial dump of transferred friles from the playbook, with anything u…

…nnecessary removed

.github/workflows/ALL-BRANCHES-ALL-PRs-build-and-deploy-to-azure.yml

@@ -0,0 +1,64 @@
+# This Action builds the rcpch.tech site in MkDocs
+# and pushes it to Azure from where it is deployed
+# Azure will also build a preview site for any PRs against LIVE or branches
+# https://bawmedical.co.uk/t/763
+
+name: ALL-BRANCHES-ALL-PRs-build-and-deploy-to-azure.yml
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - live
+
+permissions:
+  contents: write
+  pull-requests: write # this permission is required in order to allow PR comment with staging URL
+
+jobs:
+  build_and_deploy_job:
+    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
+    runs-on: ubuntu-latest
+    env:
+      ENABLE_PDF_EXPORT: 1 # Makes PDF export an option, default disabled, when building locally
+      ENABLE_GIT_COMMITTERS: True # Makes git-committers an option, default disabled, when building locally
+    name: Build and Deploy to Azure
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4 # latest as at March 2024
+        with:
+          submodules: true
+      - name: Setup Python
+        uses: actions/setup-python@v5 # latest as at March 2024
+        with:
+          python-version: "3.12"
+      - run: pip install -r requirements.txt
+      - run: mkdocs build
+        id: builddeploy
+      - name: Deploy to Azure
+        uses: Azure/static-web-apps-deploy@v1 # latest as at March 2024
+        with:
+          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_NICE_WAVE_0DA909803 }}
+          repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
+          action: "upload"
+          production_branch: "live"
+          ###### Repository/Build Configurations ######
+          app_location: "/" # App source code path
+          api_location: "" # Api source code path - optional
+          output_location: "site" # Built app content directory - optional
+          ###### End of Repository/Build Configurations ######
+
+  close_pull_request_job:
+    if: github.event_name == 'pull_request' && github.event.action == 'closed'
+    runs-on: ubuntu-latest
+    name: Close Pull Request Job
+    steps:
+      - name: Close Pull Request
+        id: closepullrequest
+        uses: Azure/static-web-apps-deploy@v1
+        with:
+          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_NICE_WAVE_0DA909803 }}
+          action: "close"

.gitignore

@@ -0,0 +1,4 @@
+*[E|e]nv
+
+site
+.cache/*

README.md

@@ -0,0 +1 @@
+# rcpch.tech

docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.11" # Docker Compose specification version! NOT the Python version
+
+services:
+  mkdocs:
+    build: .
+    volumes:
+      - .:/app/
+    ports:
+      - 8001:8001
+    environment:
+      - ENABLE_GIT_COMMITTERS=False # Disables git committer extension in local dev
+      - ENABLE_PDF_EXPORT=0 # Disables automatic PDF generation in local dev
+    command: mkdocs serve --config-file mkdocs.yml
+    restart: always

docs/_assets/_stylesheets/extra.css

@@ -0,0 +1,156 @@
+/* these are colours and fonts consistent with RCPCH branding guidelines - see github for info */
+
+:root {
+  --md-primary-fg-color: #3366cc;
+  --md-accent-fg-color: #11a7f2;
+  --rcpch-pink-color: #f18cc9;
+}
+
+/* FONTS & TYPESETTING */
+
+.md-typeset h1 {
+  font-weight: 700;
+  font-size: 24pt;
+  color: var(--md-accent-fg-color);
+}
+
+.md-typeset h2 {
+  font-weight: 700;
+  font-size: 16pt;
+  color: #4d4d4d;
+}
+
+.md-typeset h3 {
+  font-weight: 700;
+  font-size: 13pt;
+  color: #000000;
+}
+
+/* make the text bigger in the admonitions */
+.md-typeset .admonition {
+  font-size: 0.75rem;
+}
+
+
+/* HEADER & FOOTER */
+
+/* make the header white with blue text */
+.md-header {
+  background-color: #ffffff;
+  color: #0d0d58;
+}
+
+/* Switch off header hover behaviour */
+.md-search__input:hover{
+  background-color: var(--md-accent-fg-color);
+}
+
+.md-header__button:hover {
+  opacity: inherit;
+}
+
+/* Make the footer a nice RCPCH blue */
+.md-footer {
+  background-color: var(--md-primary-fg-color);
+}
+
+
+
+/* NAVIGATION */
+
+/* enlarges the font used for titles and navbar */
+.md-header__title {
+  font-size: 1.5rem;
+}
+
+.md-tabs__list {
+  font-weight: 600;
+}
+
+/* enlarges the logo image */
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+  height: 5rem !important;
+  width: auto;
+}
+
+/* widens the page view */
+.md-grid {
+  max-width: 70rem;
+}
+
+
+
+
+/* MOBILE */
+
+/* mobile  - make the header white with blue text */
+.md-nav--primary .md-nav__title[for="__drawer"] {
+  background-color: #ffffff;
+  color: #0d0d58;
+}
+
+/* mobile - enlarges the logo image */
+.md-nav__title .md-nav__button.md-logo img {
+  width: 100px;
+}
+
+
+
+
+/* IMAGES */
+
+.md-content img {
+  border-radius: 0.2em;
+  box-shadow: 0 0 0.2em 0 #777;
+}
+
+.md-content img.twemoji {
+  border-radius: 0;
+  box-shadow: 0 0 0 0 #777;
+}
+
+img[alt="doc-signature"] {
+  width: 200px;
+}
+
+/* buttons styling */
+button {
+  text-align: center;
+}
+
+.md-typeset .md-button {
+  margin: 0.2em;
+}
+
+
+/* HERO SECTION OF HOME PAGE */
+.mdx-hero__content {
+  background-color: #11a7f2;
+  padding: 3em;
+}
+
+.mdx-hero__content.md-typeset>h1,
+.mdx-hero__content.md-typeset>h2,
+.mdx-hero__content.md-typeset>p {
+  color: #ffffff;
+}
+
+.mdx-hero__content a.md-button:hover {
+    background-color: var(--rcpch-pink-color);
+    border-color: var(--rcpch-pink-color);
+}
+
+.latex img {
+  -moz-box-shadow: 0px 0px 0px #ccc;
+  -webkit-box-shadow: 0px 0px 0px #ccc;
+  box-shadow: 0px 0px 0px #ccc;
+  border: none!important;
+}
+
+img {
+  -moz-box-shadow: 0px 0px 0px #ccc;
+  -webkit-box-shadow: 0px 0px 0px #ccc;
+  box-shadow: 0px 0px 0px #ccc;
+  border: none!important;
+}

docs/authors.md

@@ -0,0 +1,10 @@
+---
+title: Authors
+reviewers:
+---
+
+This playbook was designed, developed, and written by:
+
+- Dr Marcus Baw, General Hacktitioner, Developer and Informatician, Yorkshire and The Internet.
+- Dr Simon Chapman, Consultant in Paediatric Endocrinology, King's College Hospital, London.
+- Dr Anchit Chandran, Ex-Doctor and Clinical Software Developer, London.

docs/contact.md

@@ -0,0 +1,21 @@
+---
+title: "Contact us"
+reviewers: 
+---
+
+
+## Technical and Clinical Enquiries
+
+!!! info "Signal Chat"
+
+    We have an RCPCH Developers Signal chat group for instant message support of RCPCH projects.
+
+    We can't guarantee an immediate response but our main developers see these messages and endeavour to respond as rapidly as possible. Join by using this button:
+
+    [Signal group](https://signal.group/#CjQKIAjLf5lS9OZIAI6lsJKWP1LmeJXkUW_fzZH1ryEw3oFEEhBH-4F7WnlyYjKerjfzD6B0){ .md-button .md-button--primary }
+
+## Commercial Enquiries
+
+Email our Commercial Team to ask questions about project support and pricing tiers, invoicing, contracts and other commercial matters.
+
+:material-email: <[email protected]>

docs/index.md

@@ -0,0 +1,8 @@
+---
+title: rcpch.tech
+---
+
+# rcpch.tech
+
+starter for 10 of a landing page site
+

includes/_abbreviations.md

@@ -0,0 +1,49 @@
+<!-- This file contains all the tooltip abbreviations used throughout the site, and is automatically included in every page via the `auto_append` directive in mkdocs.yml -->
+
+<!-- Please list abbreviations in alphabetical order, this aids detection of duplicates -->
+
+*[AGPL]: Affero GNU Public License
+*[API]: Application Programming Interface
+*[BMI]: Body Mass Index, a measure of weight taking into account height
+*[CLI]: Command Line Interface
+*[CRMF]: Clinical Risk Management File
+*[CRMP]: Clinical Risk Management Plan
+*[CRMS]: Clinical Risk Management System
+*[CSCR]: Clinical Safety Case Report
+*[CSO]: Clinical Safety Officer
+*[DCB]: Data Coordination Board
+*[dGC]: Digital Growth Charts
+*[DPCHR]: Digital Paediatric Child Health Record
+*[DPO]: Data Protection Officer
+*[DTAC]: Digital Technologies Assessment Criteria
+*[DVCS]: Distributed/Decentralised Version Control System/Software
+*[EHR]: Electronic Health Record
+*[EPR]: Electronic Patient Record
+*[GDPR]: General Data Protection Regulation
+*[GMDN]: Global Medical Device Nomenclature
+*[GNU]: Gnu's Not Unix
+*[GPG]: Gnu Privacy Guard
+*[HTML]: Hypertext Markup Language
+*[ICO]: Information Commissioner's Office
+*[JSON]: JavaScript Object Notation. A computer data format.
+*[LMS]: Statistical method. Lambda (Box-Cox transformation), Median height value, Skew (Generalized coefficient of variation)
+*[MDR]: Medical Device Regulation
+*[MHRA]: Medicines and Healthcare Regulatory Agency
+*[NCSC]: National Cyber Security Centre
+*[NICA]: Northern Ireland Conformity Assessed
+*[NHS]: National Health Service
+*[MIT]: Massachusetts Institute of Technology
+*[NHSD]: NHS Digital (now merged with NHS England)
+*[PGP]: Pretty Good Privacy
+*[PSF]: Python Software Foundation
+*[RCPCH]: Royal College of Paediatrics and Child Health
+*[REST]: REpresentational State Transfer
+*[SDS]: Standard Deviation Score
+*[SLA]: Service Level Agreement
+*[SNOMED-CT]: Systematic NOmenclature of MEDicine - Clinical Terms
+*[SSH]: Secure SHell
+*[SVG]: Scalable Vector Graphics
+*[UAT]: User Acceptance Testing
+*[UKCA]: United Kingdom Conformity Assessed
+*[UK-WHO]: 2009 harmonised UK and WHO growth references
+*[WHO]: World Health Organisation