Merge pull request #46 from NHSDigital/m-houston/CCM-5100-rename-iam-…

…repo CCM-5100: Update repo description for nhs-notify-iam-webauth
NHSDigital · Jul 10, 2024 · 831addf · 831addf
2 parents c5aac33 + 8c7fa19
commit 831addf
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 35 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -29,6 +29,7 @@ GEM
     ffi (1.16.3)
     forwardable-extended (2.6.0)
     gemoji (4.1.0)
+    google-protobuf (3.25.3-arm64-darwin)
     google-protobuf (3.25.3-x86_64-linux)
     html-pipeline (2.14.3)
       activesupport (>= 2)
@@ -90,6 +91,8 @@ GEM
       jekyll-seo-tag (~> 2.1)
     minitest (5.23.1)
     mutex_m (0.2.0)
+    nokogiri (1.16.5-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
     pathutil (0.16.2)
@@ -104,9 +107,10 @@ GEM
       strscan (>= 3.0.9)
     rouge (4.2.1)
     safe_yaml (1.0.5)
-    sass-embedded (1.69.5)
+    sass-embedded (1.69.5-arm64-darwin)
+      google-protobuf (~> 3.23)
+    sass-embedded (1.69.5-x86_64-linux-gnu)
       google-protobuf (~> 3.23)
-      rake (>= 13.0.0)
     strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -116,6 +120,7 @@ GEM
     webrick (1.8.1)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

diff --git a/docs/_includes/notify-repo-list.html b/docs/_includes/notify-repo-list.html
@@ -4,7 +4,7 @@ <h2>Repository List</h2>
   {% for repo in site.repos %} {% if repo.order > 0 %}
   <li>
     <a href="{{site.baseurl}}/repos/{{repo.repo-name}}.html">
-      {{ repo.name }} - {{ repo.description }}
+      {{ repo.repo-name }} - {{ repo.name }}
     </a>
   </li>
   {% endif %} {% endfor %}

diff --git a/docs/_includes/page-info-header.html b/docs/_includes/page-info-header.html
@@ -2,10 +2,10 @@
   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>
+  <h1>{{ page.name }}</h1>
   <p class="text-medium text-grey-dk-300 mb-0">{{ page.summary }}</p>
   {% else %}
-  <h1>{{ page.title }}</h1>
+  <h1>{{ page.name }}</h1>
   {% endif %}
 
   <div class="page-info">
@@ -21,9 +21,8 @@ <h1>{{ page.title }}</h1>
         >🧾 History</a
       >
 
-      {% endif %} | {% if page.author %} ✍ {{page.author}} {% else %} ✍ Ross
-      Buggins {% endif %} | {% if page.owner %} 🔑 {{page.owner}} {% else %} 🔑
-      Ross Buggins {% endif %}
+      {% endif %} | {% if page.author %} ✍ {{page.author}} {% else %} ✍ NHS Notify {% endif %} | {% if page.owner %} 🔑 {{page.owner}} {% else %} 🔑
+      NHS Notify {% endif %}
 
     <p class="text-small text-grey-dk-300 mb-0">
       {% for tag in page.tags %}<a class="text-small" href="/tags/{{tag}}.html"

diff --git a/docs/_layouts/notify-repo.md b/docs/_layouts/notify-repo.md
@@ -4,19 +4,15 @@ layout: page
 
 <!-- markdownlint-disable MD041 -->
 
-<p>
-<a href="https://github.com/NHSDigital/{{page.repo-name}}">https://github.com/NHSDigital/{{page.repo-name}}</a>
-</p>
+<dl>
+  <dt>Repository</dt>
+  <dd><a href="https://github.com/NHSDigital/{{page.repo-name}}">https://github.com/NHSDigital/{{page.repo-name}}</a></dd>
 
-<h2>Authors</h2>
-
-<ul>
+<dt>Owners</dt>
 {% for owner in page.owners %}
-    <li> <a href="http://github.com/{{owner}}">{{owner}}</a> </li>
+    <dd> <a href="http://github.com/{{owner}}">{{owner}}</a> </dd>
 {% endfor %}
-</ul>
-
-<h2>Content</h2>
+</dl>
 
 {{ content }}
 

diff --git a/docs/collections/_repos/nhs-notify-iam-webauth.md b/docs/collections/_repos/nhs-notify-iam-webauth.md
@@ -0,0 +1,17 @@
+---
+repo-name: nhs-notify-iam-webauth
+owners: [ "rossbugginsnhs", "m-houston" ]
+title: nhs-notify-iam-webauth
+name: Notify IAM Web Authentication
+description: OIDC Authentication Micro-Frontend for Web UI
+author: "Mike Houston"
+order: 3
+parent: Repositories
+---
+
+### Purpose
+
+This repository contains a Micro-Frontend (MFE) web application which handles user login using a Cognito User Pool
+
+Other MFEs composed into a single web application can access the authenticated user credentials via a cookie set for the
+shared domain.
diff --git a/docs/collections/_repos/nhs-notify-iam.md b/docs/collections/_repos/nhs-notify-iam.md
diff --git a/scripts/config/vale/styles/Vocab/words/accept.txt b/scripts/config/vale/styles/Vocab/words/accept.txt
@@ -24,3 +24,4 @@ drawio
 endraw
 [Oo]nboarding
 relative_url
+Cognito
diff --git a/scripts/terraform/terraform.mk b/scripts/terraform/terraform.mk
@@ -44,8 +44,8 @@ _terraform: # Terraform command wrapper - mandatory: cmd=[command to execute]; o
 	# 'TERRAFORM_STACK' is passed to the functions as environment variable
 	TERRAFORM_STACK=$(or ${TERRAFORM_STACK}, $(or ${terraform_stack}, $(or ${STACK}, $(or ${stack}, scripts/terraform/examples/terraform-state-aws-s3))))
 	dir=$(or ${dir}, ${TERRAFORM_STACK})
-	source scripts/terraform/terraform.lib.sh
-	terraform-${cmd} # 'dir' and 'opts' are accessible by the function as environment variables, if set
+	. scripts/terraform/terraform.lib.sh && \
+		terraform-${cmd} # 'dir' and 'opts' are accessible by the function as environment variables, if set
 
 # ==============================================================================
 # Quality checks - please DO NOT edit this section!
@@ -68,8 +68,8 @@ terraform-example-destroy-aws-infrastructure: # Destroy example of AWS infrastru
 
 terraform-example-clean: # Remove Terraform example files @ExamplesAndTests
 	dir=$(or ${dir}, ${TERRAFORM_STACK})
-	source scripts/terraform/terraform.lib.sh
-	terraform-clean
+	. scripts/terraform/terraform.lib.sh && \
+		terraform-clean
 	rm -f ${TERRAFORM_STACK}/.terraform.lock.hcl
 
 # ==============================================================================
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,3 +24,4 @@ drawio @@
     endraw
     [Oo]nboarding
     relative_url
+    Cognito