🐴 Minor changes to documentation (#85)

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

Hide file tree

Showing 11 changed files with 25 additions and 22 deletions.
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -26,6 +26,6 @@ jobs:
 
       - name: Dependency Review
         id: dependency_review
-        uses: actions/dependency-review-action@4081bf99e2866ebe428fc0477b69eb4fcda7220a # v4.4.0
+        uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0
         with:
           fail-on-severity: critical
diff --git a/.github/workflows/openssf-scorecard.yml b/.github/workflows/openssf-scorecard.yml
@@ -42,6 +42,6 @@ jobs:
 
       - name: Upload to CodeQL
         id: upload_to_codeql
-        uses: github/codeql-action/upload-sarif@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
+        uses: github/codeql-action/upload-sarif@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6
         with:
           sarif_file: results.sarif
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -17,7 +17,7 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:35699473dbeefeeb8b597de024125a241277ee03587d5fe8e72545e4b27b33f8 # v5.0.0
+      image: ghcr.io/ministryofjustice/tech-docs-github-pages-publisher@sha256:aee182dd1dd86696077ea1c3512590f17ceb9f7a47aa5b16ea4f742666911dbd # v5.0.1
     permissions:
       contents: read
     steps:

diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml
@@ -29,7 +29,7 @@ jobs:
 
       - name: Super-Linter
         id: super_linter
-        uses: super-linter/super-linter/slim@b92721f792f381cedc002ecdbb9847a15ece5bb8 # v7.1.0
+        uses: super-linter/super-linter/slim@e1cb86b6e8d119f789513668b4b30bf17fe1efe4 # v7.2.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_CSS: false

diff --git a/Makefile b/Makefile
@@ -1,14 +1,16 @@
 .PHONY: package preview
 
-IMAGE_NAME ?= ghcr.io/ministryofjustice/tech-docs-github-pages-publisher
-IMAGE_SHA  ?= sha256:35699473dbeefeeb8b597de024125a241277ee03587d5fe8e72545e4b27b33f8
+.DEFAULT_GOAL := preview
+
+TECH_DOCS_GITHUB_PAGES_PUBLISHER_IMAGE     ?= ghcr.io/ministryofjustice/tech-docs-github-pages-publisher
+TECH_DOCS_GITHUB_PAGES_PUBLISHER_IMAGE_SHA ?= sha256:aee182dd1dd86696077ea1c3512590f17ceb9f7a47aa5b16ea4f742666911dbd # v5.0.1
 
 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) \
+		$(TECH_DOCS_GITHUB_PAGES_PUBLISHER_IMAGE)@$(TECH_DOCS_GITHUB_PAGES_PUBLISHER_IMAGE_SHA) \
 		/usr/local/bin/package
 
 preview:
@@ -17,5 +19,5 @@ 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) \
+		$(TECH_DOCS_GITHUB_PAGES_PUBLISHER_IMAGE)@$(TECH_DOCS_GITHUB_PAGES_PUBLISHER_IMAGE_SHA) \
 		/usr/local/bin/preview
diff --git a/README.md b/README.md
@@ -2,10 +2,12 @@
 
 [![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 Dev Container](https://raw.githubusercontent.com/ministryofjustice/.devcontainer/refs/heads/main/contrib/badge.svg)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/ministryofjustice/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 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,6 @@ header_links:
 host: https://user-guide.observability-platform.service.justice.gov.uk
 max_toc_heading_level: 3
 owner_slack_workspace: mojdt
-phase: DISCOVERY
 prevent_indexing: true
 service_link: /
 service_name: Observability Platform User Guide

diff --git a/source/getting-started/accessing.html.md.erb b/source/getting-started/accessing.html.md.erb
@@ -1,6 +1,6 @@
 ---
-title: Accessing Observability Platform
-last_reviewed_on: 2024-11-04
+title: Accessing the Observability Platform
+last_reviewed_on: 2024-12-04
 review_in: 3 months
 weight: 0
 ---
@@ -9,7 +9,7 @@ weight: 0
 
 ## Overview
 
-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).
+Once you have finished [onboarding to the Observability Platform](/documentation/getting-started/onboarding.html), you can access Grafana by using the [AWS access portal](https://moj.awsapps.com/start/#/saml/default/observability-platform/ins-c311263047063806).
 
 ## Using Grafana
 

diff --git a/source/getting-started/onboarding.html.md.erb b/source/getting-started/onboarding.html.md.erb
@@ -1,6 +1,6 @@
 ---
-title: Onboarding to Observability Platform
-last_reviewed_on: 2024-11-04
+title: Onboarding to the Observability Platform
+last_reviewed_on: 2024-12-04
 review_in: 3 months
 weight: 0
 ---
@@ -19,7 +19,7 @@ Once onboarding has been agreed with the Observability Platform team, you will n
 
 * Tenant name (e.g. `Observability Platform`)
 
-* GitHub team (e.g. `observability-platform`)
+* AWS IAM Identity Center team (e.g. `observability-platform`)
 
 * AWS accounts and whether
 
@@ -35,7 +35,7 @@ Once onboarding has been agreed with the Observability Platform team, you will n
 
   * any Slack channels
 
-## Deploying Observability Platform Terraform Module
+## Deploying Observability Platform's Terraform Module
 
 To access Amazon CloudWatch and X-Ray in your account, the Observability Platform team have created a Terraform module to create the required resources.
 

diff --git a/source/index.html.md.erb b/source/index.html.md.erb
@@ -1,13 +1,13 @@
 ---
 title: Observability Platform User Guide
-last_reviewed_on: 2024-11-04
+last_reviewed_on: 2024-12-04
 review_in: 3 months
 weight: 0
 ---
 
 # <%= current_page.data.title %>
 
-> ⚠️ The service is currently in discovery 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 the Observability Platform.
 

diff --git a/source/overview/index.html.md.erb b/source/overview/index.html.md.erb
@@ -1,6 +1,6 @@
 ---
-title: What is Observability Platform?
-last_reviewed_on: 2024-11-04
+title: What is the Observability Platform?
+last_reviewed_on: 2024-12-04
 review_in: 3 months
 weight: 0
 ---
@@ -9,7 +9,7 @@ weight: 0
 
 ## Overview
 
-The Ministry of Justice's Observability Platform is a prototype service for applications that are running on
+The Ministry of Justice's Observability Platform is a service for applications that are running on
 the [Ministry of Justice's Modernisation Platform](https://user-guide.modernisation-platform.service.justice.gov.uk/).
 
 The Observability Platform provides a way for teams to: