🧹 Housekeeping (#75)

Signed-off-by: Jacob Woffenden <jacob.woffenden@justice.gov.uk>
ministryofjustice · Nov 5, 2024 · f0a14e6 · f0a14e6
1 parent eb8acd2
commit f0a14e6
Show file tree

Hide file tree

Showing 16 changed files with 59 additions and 59 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -9,10 +9,16 @@ updates:
     commit-message:
       prefix: ":dependabot: github-actions"
       include: "scope"
+    labels:
+      - "dependabot"
+      - "github-actions"
   - package-ecosystem: "devcontainers"
     directory: "/"
     schedule:
       interval: "daily"
     commit-message:
       prefix: ":dependabot: devcontainers"
       include: "scope"
+    labels:
+      - "dependabot"
+      - "devcontainers"
diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -1,8 +1,10 @@
 ---
-name: Dependency Review
+name: 🔍 Dependency Review
 
 on:
   pull_request:
+    branches:
+      - main
     types:
       - edited
       - opened
@@ -23,6 +25,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Dependency Review
-        uses: actions/dependency-review-action@5a2ce3f5b92ee19cbb1541a4984c76d921601d7c # v4.3.4
+        id: dependency_review
+        uses: actions/dependency-review-action@4081bf99e2866ebe428fc0477b69eb4fcda7220a # v4.4.0
         with:
           fail-on-severity: critical
diff --git a/.github/workflows/openssf-scorecard.yml b/.github/workflows/openssf-scorecard.yml
@@ -1,5 +1,5 @@
 ---
-name: OpenSSF Scorecard
+name: 🛡️ OpenSSF Scorecard
 
 on:
   branch_protection_rule:

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,5 +1,5 @@
 ---
-name: Build and Publish
+name: 🚀 Publish
 
 on:
   push:
@@ -17,7 +17,7 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     container:
-      image: docker.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:cd3513beca3fcaf5dd34cbe81a33b3ff30337d8ada5869b40a6454c21d6f7684 # v4.0.0
+      image: ghcr.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:35699473dbeefeeb8b597de024125a241277ee03587d5fe8e72545e4b27b33f8 # v5.0.0
     permissions:
       contents: read
     steps:

diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml
@@ -1,5 +1,5 @@
 ---
-name: Super-Linter
+name: 🦝 Super-Linter
 
 on:
   pull_request:
@@ -32,5 +32,5 @@ jobs:
         uses: super-linter/super-linter/slim@b92721f792f381cedc002ecdbb9847a15ece5bb8 # v7.1.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DEFAULT_BRANCH: main
           VALIDATE_CSS: false
+          VALIDATE_JSCPD: false
diff --git a/.github/workflows/build-test.yml → .github/workflows/test.yml b/.github/workflows/build-test.yml → .github/workflows/test.yml
@@ -1,5 +1,5 @@
 ---
-name: Build and Test
+name: 🧪 Test
 
 on:
   pull_request:
@@ -13,7 +13,7 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     container:
-      image: docker.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:cd3513beca3fcaf5dd34cbe81a33b3ff30337d8ada5869b40a6454c21d6f7684 # v4.0.0
+      image: ghcr.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:35699473dbeefeeb8b597de024125a241277ee03587d5fe8e72545e4b27b33f8 # v5.0.0
     permissions:
       contents: read
     steps:
@@ -26,8 +26,8 @@ jobs:
         run: |
           /usr/local/bin/package
 
-  test:
-    name: Test
+  link-checker:
+    name: Link Checker
     runs-on: ubuntu-latest
     permissions:
       contents: read

diff --git a/Makefile b/Makefile
@@ -0,0 +1,21 @@
+.PHONY: package preview
+
+IMAGE_NAME ?= ghcr.io/ministryofjustice/tech-docs-github-pages-publisher
+IMAGE_SHA  ?= sha256:35699473dbeefeeb8b597de024125a241277ee03587d5fe8e72545e4b27b33f8
+
+package:
+	docker run --rm \
+	    --name tech-docs-github-pages-publisher \
+	    --volume $(PWD)/config:/tech-docs-github-pages-publisher/config \
+		--volume $(PWD)/source:/tech-docs-github-pages-publisher/source \
+		$(IMAGE_NAME)@$(IMAGE_SHA) \
+		/usr/local/bin/package
+
+preview:
+	docker run -it --rm \
+	    --name tech-docs-github-pages-publisher-preview \
+	    --volume $(PWD)/config:/tech-docs-github-pages-publisher/config \
+		--volume $(PWD)/source:/tech-docs-github-pages-publisher/source \
+		--publish 4567:4567 \
+		$(IMAGE_NAME)@$(IMAGE_SHA) \
+		/usr/local/bin/preview
diff --git a/README.md b/README.md
@@ -2,8 +2,10 @@
 
 [![repo standards badge](https://img.shields.io/endpoint?labelColor=231f20&color=005ea5&style=for-the-badge&label=MoJ%20Compliant&url=https%3A%2F%2Foperations-engineering-reports.cloud-platform.service.justice.gov.uk%2Fapi%2Fv1%2Fcompliant_public_repositories%2Fendpoint%2Fobservability-platform-user-guide&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAABmJLR0QA/wD/AP+gvaeTAAAHJElEQVRYhe2YeYyW1RWHnzuMCzCIglBQlhSV2gICKlHiUhVBEAsxGqmVxCUUIV1i61YxadEoal1SWttUaKJNWrQUsRRc6tLGNlCXWGyoUkCJ4uCCSCOiwlTm6R/nfPjyMeDY8lfjSSZz3/fee87vnnPu75z3g8/kM2mfqMPVH6mf35t6G/ZgcJ/836Gdug4FjgO67UFn70+FDmjcw9xZaiegWX29lLLmE3QV4Glg8x7WbFfHlFIebS/ANj2oDgX+CXwA9AMubmPNvuqX1SnqKGAT0BFoVE9UL1RH7nSCUjYAL6rntBdg2Q3AgcAo4HDgXeBAoC+wrZQyWS3AWcDSUsomtSswEtgXaAGWlVI2q32BI0spj9XpPww4EVic88vaC7iq5Hz1BvVf6v3qe+rb6ji1p3pWrmtQG9VD1Jn5br+Knmm70T9MfUh9JaPQZu7uLsR9gEsJb3QF9gOagO7AuUTom1LpCcAkoCcwQj0VmJregzaipA4GphNe7w/MBearB7QLYCmlGdiWSm4CfplTHwBDgPHAFmB+Ah8N9AE6EGkxHLhaHU2kRhXc+cByYCqROs05NQq4oR7Lnm5xE9AL+GYC2gZ0Jmjk8VLKO+pE4HvAyYRnOwOH5N7NhMd/WKf3beApYBWwAdgHuCLn+tatbRtgJv1awhtd838LEeq30/A7wN+AwcBt+bwpD9AdOAkYVkpZXtVdSnlc7QI8BlwOXFmZ3oXkdxfidwmPrQXeA+4GuuT08QSdALxC3OYNhBe/TtzON4EziZBXD36o+q082BxgQuqvyYL6wtBY2TyEyJ2DgAXAzcC1+Xxw3RlGqiuJ6vE6QS9VGZ/7H02DDwAvELTyMDAxbfQBvggMAAYR9LR9J2cluH7AmnzuBowFFhLJ/wi7yiJgGXBLPq8A7idy9kPgvAQPcC9wERHSVcDtCfYj4E7gr8BRqWMjcXmeB+4tpbyG2kG9Sl2tPqF2Uick8B+7szyfvDhR3Z7vvq/2yqpynnqNeoY6v7LvevUU9QN1fZ3OTeppWZmeyzRoVu+rhbaHOledmoQ7LRd3SzBVeUo9Wf1DPs9X90/jX8m/e9Rn1Mnqi7nuXXW5+rK6oU7n64mjszovxyvVh9WeDcTVnl5KmQNcCMwvpbQA1xE8VZXhwDXAz4FWIkfnAlcBAwl6+SjD2wTcmPtagZnAEuA3dTp7qyNKKe8DW9UeBCeuBsbsWKVOUPvn+MRKCLeq16lXqLPVFvXb6r25dlaGdUx6cITaJ8fnpo5WI4Wuzcjcqn5Y8eI/1F+n3XvUA1N3v4ZamIEtpZRX1Y6Z/DUK2g84GrgHuDqTehpBCYend94jbnJ34DDgNGArQT9bict3Y3p1ZCnlSoLQb0sbgwjCXpY2blc7llLW1UAMI3o5CD4bmuOlwHaC6xakgZ4Z+ibgSxnOgcAI4uavI27jEII7909dL5VSrimlPKgeQ6TJCZVQjwaOLaW8BfyWbPEa1SaiTH1VfSENd85NDxHt1plA71LKRvX4BDaAKFlTgLeALtliDUqPrSV6SQCBlypgFlbmIIrCDcAl6nPAawmYhlLKFuB6IrkXAadUNj6TXlhDcCNEB/Jn4FcE0f4UWEl0NyWNvZxGTs89z6ZnatIIrCdqcCtRJmcCPwCeSN3N1Iu6T4VaFhm9n+riypouBnepLsk9p6p35fzwvDSX5eVQvaDOzjnqzTl+1KC53+XzLINHd65O6lD1DnWbepPBhQ3q2jQyW+2oDkkAtdt5udpb7W+Q/OFGA7ol1zxu1tc8zNHqXercfDfQIOZm9fR815Cpt5PnVqsr1F51wI9QnzU63xZ1o/rdPPmt6enV6sXqHPVqdXOCe1rtrg5W7zNI+m712Ir+cer4POiqfHeJSVe1Raemwnm7xD3mD1E/Z3wIjcsTdlZnqO8bFeNB9c30zgVG2euYa69QJ+9G90lG+99bfdIoo5PU4w362xHePxl1slMab6tV72KUxDvzlAMT8G0ZohXq39VX1bNzzxij9K1Qb9lhdGe931B/kR6/zCwY9YvuytCsMlj+gbr5SemhqkyuzE8xau4MP865JvWNuj0b1YuqDkgvH2GkURfakly01Cg7Cw0+qyXxkjojq9Lw+vT2AUY+DlF/otYq1Ixc35re2V7R8aTRg2KUv7+ou3x/14PsUBn3NG51S0XpG0Z9PcOPKWSS0SKNUo9Rv2Mmt/G5WpPF6pHGra7Jv410OVsdaz217AbkAPX3ubkm240belCuudT4Rp5p/DyC2lf9mfq1iq5eFe8/lu+K0YrVp0uret4nAkwlB6vzjI/1PxrlrTp/oNHbzTJI92T1qAT+BfW49MhMg6JUp7ehY5a6Tl2jjmVvitF9fxo5Yq8CaAfAkzLMnySt6uz/1k6bPx59CpCNxGfoSKA30IPoH7cQXdArwCOllFX/i53P5P9a/gNkKpsCMFRuFAAAAABJRU5ErkJggg==)](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-report/observability-platform-user-guide)
 
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/ministryofjustice/observability-platform-user-guide)
+
 > [!IMPORTANT]
-> The service is currently in discovery phase and subject to change.
+> The service is currently in discovery and subject to change.
 
 ## About this repository
 

diff --git a/config/tech-docs.yml b/config/tech-docs.yml
@@ -14,7 +14,7 @@ header_links:
 host: https://user-guide.observability-platform.service.justice.gov.uk
 max_toc_heading_level: 3
 owner_slack_workspace: mojdt
-phase: discovery
+phase: DISCOVERY
 prevent_indexing: true
 service_link: /
 service_name: Observability Platform User Guide

diff --git a/scripts/local.sh b/scripts/local.sh
diff --git a/...ion/getting-started/accessing.html.md.erb → source/getting-started/accessing.html.md.erb b/...ion/getting-started/accessing.html.md.erb → source/getting-started/accessing.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Accessing Observability Platform
-last_reviewed_on: 2024-04-16
+last_reviewed_on: 2024-11-04
 review_in: 3 months
 weight: 0
 ---
@@ -9,7 +9,7 @@ weight: 0
 
 ## Overview
 
-Once you have finished [onboarding to Observability Platform](/documentation/getting-started/onboarding.html), you can access Grafana by using the [AWS access portal](https://moj.awsapps.com/start/#/?tab=applications).
+Once you have finished [onboarding to Observability Platform](/getting-started/onboarding.html), you can access Grafana by using the [AWS access portal](https://moj.awsapps.com/start/#/?tab=applications).
 
 ## Using Grafana
 
@@ -23,4 +23,4 @@ As a tenant, you will have access to:
 
 * A folder to create dashboards and alerts
 
-For comprehensive documentation, please refer to [Grafana Labs' documentation site](https://grafana.com/docs/grafana/v9.4/).
+For comprehensive documentation, please refer to [Grafana Labs' documentation site](https://grafana.com/docs/grafana/v10.4/).
diff --git a/...on/getting-started/onboarding.html.md.erb → ...ce/getting-started/onboarding.html.md.erb b/...on/getting-started/onboarding.html.md.erb → ...ce/getting-started/onboarding.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Onboarding to Observability Platform
-last_reviewed_on: 2024-06-28
+last_reviewed_on: 2024-11-04
 review_in: 3 months
 weight: 0
 ---
@@ -48,7 +48,7 @@ module "observability_platform_tenant" {
   source  = "ministryofjustice/observability-platform-tenant/aws"
   version = "<see https://registry.terraform.io/modules/ministryofjustice/observability-platform-tenant/aws/latest for latest>"
 
-  observability_platform_account_id = local.environment_management.account_ids["observability-platform-${ENVIRONMENT}"]
+  observability_platform_account_id = local.environment_management.account_ids["observability-platform-production"]
 
   tags = local.tags
 }

diff --git a/source/index.html.md.erb b/source/index.html.md.erb
@@ -1,25 +1,25 @@
 ---
 title: Observability Platform User Guide
-last_reviewed_on: 2024-04-15
+last_reviewed_on: 2024-11-04
 review_in: 3 months
 weight: 0
 ---
 
 # <%= current_page.data.title %>
 
-<%= warning_text('The service is currently in discovery phase and subject to change.') %>
+> ⚠️ The service is currently in discovery and subject to change
 
-This documentation is for teams who wish to integrate their applications and environments with Observability Platform.
+This documentation is for teams who wish to integrate their applications and environments with the Observability Platform.
 
 ## Overview
 
-- [What is Observability Platform?](/documentation/overview/index.html)
+- [What is the Observability Platform?](/overview/index.html)
 
 ## Getting Started
 
-- [Onboarding to Observability Platform](/documentation/getting-started/onboarding.html)
+- [Onboarding to the Observability Platform](/getting-started/onboarding.html)
 
-- [Accessing Observability Platform](/documentation/getting-started/accessing.html)
+- [Accessing the Observability Platform](/getting-started/accessing.html)
 
 ## Getting Help
 

diff --git a/source/javascripts/govuk_frontend.js b/source/javascripts/govuk_frontend.js
@@ -0,0 +1 @@
+//= require govuk_frontend_all
diff --git a/.../documentation/overview/index.html.md.erb → source/overview/index.html.md.erb b/.../documentation/overview/index.html.md.erb → source/overview/index.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: What is Observability Platform?
-last_reviewed_on: 2024-06-28
+last_reviewed_on: 2024-11-04
 review_in: 3 months
 weight: 0
 ---
@@ -22,4 +22,4 @@ The Observability Platform team maintains the infrastructure, allowing teams to
 
 ## High Level Architecture
 
-![Observability Platform high level architecture](https://observability-platform.service.justice.gov.uk/documentation/platform-architecture/src/architecture.svg)
+![Observability Platform high level architecture](https://observability-platform.service.justice.gov.uk/architecture/src/architecture.svg)