ministryofjustice · ASTRobinson · Apr 22, 2024 · Apr 22, 2024
@@ -1,8 +1,10 @@
+# Minimise Comments
+
 Script for hiding comments in a PR
 
 Set environment variables as follows before running the script
 
-```
+```go
 COMMENT_BODY_CONTAINS="set this to a string which is in the comment to hide"
 PR_NUMBER="set this to the PR number"
 GITHUB_REPOSITORY="set to name of repo"
@@ -11,7 +13,7 @@ GITHUB_TOKEN="set to github token"
 
 Example usage once environment vars are set
 
-```
+```go
 go build
 ./minimise-comments
 ```
@@ -1,8 +1,6 @@
-This `ecs` local Terraform module is taken from the MP provided module - <https://github.com/ministryofjustice/modernisation-platform-terraform-ecs>, and subsequently we have developed from the code there. Below is the README.md taken form the MP module.
-
 # Modernisation Platform ECS Cluster Module
 
-[![repo standards badge](https://img.shields.io/badge/dynamic/json?color=blue&style=for-the-badge&logo=github&label=MoJ%20Compliant&query=%24.result&url=https%3A%2F%2Foperations-engineering-reports.cloud-platform.service.justice.gov.uk%2Fapi%2Fv1%2Fcompliant_public_repositories%2Fmodernisation-platform-terraform-ecs)](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-github-repositories.html#modernisation-platform-terraform-ecs "Link to report")
+This `ecs` local Terraform module is taken from the MP provided module - <https://github.com/ministryofjustice/modernisation-platform-terraform-ecs>, and subsequently we have developed from the code there. Below is the README.md taken form the MP module.
 
 ## Usage
 
@@ -141,4 +139,4 @@ No modules.
 
 ## Looking for issues?
 
-If you're looking to raise an issue with this module, please create a new issue in the [Modernisation Platform repository](https://github.com/ministryofjustice/modernisation-platform/issues).
+If you're looking to raise an issue with this module, please create a new issue in the [Modernisation Platform repository](https://github.com/ministryofjustice/modernisation-platform/issues).
@@ -1,11 +1,13 @@
+# SSH keys
+
 Each environment has its own public/private ssh key pair for the default ec2-user.
 The private key is uploaded as a SSM parameter in each environment under `ec2-user_pem`.
 
 # Creating Keys
 
 1. Generate keys (don't set password)
 
-```
+```shell
 app=corporate-staff-rostering
 for env in development test preproduction production; do
   mkdir -p $app-$env
@@ -21,7 +23,7 @@ done
 
 Assumes you have correct aws config profiles setup
 
-```
+```shell
 app=corporate-staff-rostering
 for env in development test preproduction production; do
   pem=$(cat $app-$env/ec2-user)
@@ -31,7 +33,7 @@ done
 
 4. Delete any local private keys
 
-```
+```shell
 rm */ec2-user
 ```
 
@@ -43,7 +45,8 @@ Example ssh config found [here](https://github.com/ministryofjustice/dso-useful-
 This assumes keys are stored under your .ssh directory, e.g. `~/.ssh/corporate-staff-rostering-development/ec2-user`
 
 Setup soft links in your own .ssh directory like this
-```
+
+```shell
   dir=$(pwd)
   (
     cd ~/.ssh

@@ -8,6 +8,7 @@ _If you have any questions surrounding this page please post in the `#dso-intern
 ## Mandatory Information
 
 ### **Last review date:**
+
 11/03/2024
 
 ### **Description:**
@@ -16,35 +17,35 @@ CSR provides scheduling, annual leave & overtime for around 30,000 Prison Office
 
 ### **Service URLs:**
 
-*Production:*
-Region | Geographical regions | URL|
-| -------- | ------------------------ | ----------------------------- |
-| Region 1 | North East & West Midlands | r1.csr.service.justice.gov.uk |
+_Production:_
+
+| Region   | Geographical regions                      | URL                           |
+| -------- | ----------------------------------------- | ----------------------------- |
+| Region 1 | North East & West Midlands                | r1.csr.service.justice.gov.uk |
 | Region 2 | Yorkshire & Humbleside, and High Security | r2.csr.service.justice.gov.uk |
-| Region 3 | North West & London | r3.csr.service.justice.gov.uk |
-| Region 4 | Wales & South Central | r4.csr.service.justice.gov.uk |
-| Region 5 | Eastern & South West | r5.csr.service.justice.gov.uk |
-| Region 6 | East Midlands, and Kent & Sussex | r6.csr.service.justice.gov.uk |
+| Region 3 | North West & London                       | r3.csr.service.justice.gov.uk |
+| Region 4 | Wales & South Central                     | r4.csr.service.justice.gov.uk |
+| Region 5 | Eastern & South West                      | r5.csr.service.justice.gov.uk |
+| Region 6 | East Midlands, and Kent & Sussex          | r6.csr.service.justice.gov.uk |
 
-*Training Servers:*  
+_Training Servers:_  
 traina.pp.csr.service.justice.gov.uk  
-trainb.pp.csr.service.justice.gov.uk  
-
+trainb.pp.csr.service.justice.gov.uk
 
-### **Incident response hours:**  
+### **Incident response hours:**
 
-24/7/365 cover is provided by the Application Support Team for application issues, and DBAs for database issues.  
+24/7/365 cover is provided by the Application Support Team for application issues, and DBAs for database issues.
 
-### **Incident contact details:**  
+### **Incident contact details:**
 
 Email <[email protected]> for database issues.
 Email <[email protected]> for application issues.  
-Email <[email protected]> for infrastructure issues.  
+Email <[email protected]> for infrastructure issues.
 
-### **Service team contact:**  
+### **Service team contact:**
 
 ask-digital-studio-ops  
-<[email protected]>  
+<[email protected]>
 
 ### **Hosting environment:**
 

@@ -1,7 +1,10 @@
-# All config files
+# Configuration Files
+
+## All config files
+
 - credentials have been removed and replaced with template values
 
-# iis-R1 & iis-R2 configs
+## iis-R1 & iis-R2 configs
+
 - all application settings code blocks have been removed from sample config files
 - application settings code is NOT the same between R1 & R2
-
@@ -1,9 +1,11 @@
+# SSH keys
+
 Each environment has its own public/private ssh key pair for the default ec2-user.
 The private key is uploaded as a SSM parameter in each environment under `ec2-user_pem`.
 
 For example:
 
-```
+```shell
 PROFILE=delius-iaps-development #for example
 pem=$(cat $PROFILE/ec2-user)
 aws ssm put-parameter --name "ec2-user_pem" --type "SecureString" --data-type "text" --value "$pem" --profile "$PROFILE"

@@ -1,11 +1,13 @@
+# SSH keys
+
 Each environment has its own public/private ssh key pair for the default ec2-user.
 The private key is uploaded as a SSM parameter in each environment under `ec2-user_pem`.
 
 # Creating Keys
 
 1. Generate keys (don't set password)
 
-```
+```shell
 app=hmpps-oem
 for env in development test preproduction production; do
   mkdir -p $app-$env
@@ -21,7 +23,7 @@ done
 
 Assumes you have correct aws config profiles setup
 
-```
+```shell
 app=hmpps-oem
 for env in development test preproduction production; do
   pem=$(cat $app-$env/ec2-user)
@@ -31,7 +33,7 @@ done
 
 4. Delete any local private keys
 
-```
+```shell
 rm */ec2-user
 ```
 
@@ -43,7 +45,8 @@ Example ssh config found [here](https://github.com/ministryofjustice/dso-useful-
 This assumes keys are stored under your .ssh directory, e.g. `~/.ssh/hmpps-oem-development/ec2-user`
 
 Setup soft links in your own .ssh directory like this
-```
+
+```shell
   dir=$(pwd)
   (
     cd ~/.ssh

@@ -14,6 +14,7 @@ _If you have any questions surrounding this page please post in the `#ask-laa-op
 ### **Description:**
 
 <!-- A short (less than 50 word) description of what your service does, and who it’s for.-->
+
 MLRA (Means Assessment Administration Tool - Libra Record Access) is a web enabled application used to process criminal legal aid applications in the Magistrates and Crown Courts.
 
 Also used for assessing if defendants are entitled to legal aid for criminal cases. End users consist of approximately 400 criminal case workers.
@@ -36,21 +37,20 @@ Also <https://mlra.legalservices.gov.uk/mlra/> redirects to the above URL. This
 
 <!-- How people can raise an urgent issue with your service. This must not be the email address or phone number of an individual on your team, it should be a shared email address, phone number, or website that allows someone with an urgent issue to raise it quickly. -->
 
-# laa-crime-apps is the slack channel for raising any issues with the product team
+## laa-crime-apps is the slack channel for raising any issues with the product team
 
 ### **Service team contact:**
 
 <!-- How people with non-urgent issues or questions can get in touch with your team. As with incident contact details, this must not be the email address or phone number of an individual on the team, it should be a shared email address or a ticket tracking system.-->
 
-# laa-crime-apps
+## laa-crime-apps
 
 ### **Hosting environment:**
 
 Modernisation Platform
 
 <!-- If your service is hosted on another MOJ team’s infrastructure, link to their runbook. If your service has another arrangement or runs its own infrastructure, you should list the supplier of that infrastructure (ideally linking to your account’s login page) and describe, simply and briefly, how to raise an issue with them. -->
 
-
 ## Optional
 
 ### **Other URLs:**