From 7694fabb529fd5f9561d79ee4ebc8c83e46c5cee Mon Sep 17 00:00:00 2001 From: Jacob Woffenden <jacob@woffenden.io> Date: Mon, 25 Nov 2024 10:56:27 +0000 Subject: [PATCH 1/3] Initial update --- .devcontainer/README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index bf6a524f218..1d71e3c733e 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,28 +1,32 @@ # Dev Container +> [!NOTE] > This is a community supported feature -To assist in the development of `modernisation-platform-environments`, the community have built a [dev container](https://containers.dev/) with the required tooling +To assist with working on this repository, the community has configured a [dev container](https://containers.dev/) with the required tooling. -## Prerequisites +You can run this locally, or with [GitHub Codespaces](https://docs.github.com/en/codespaces/overview). -- GitHub Codespaces +## GitHub Codespaces -or +To launch a GitHub Codespace, use the button below: -- Docker +[![Open in Codespace](https://github.com/codespaces/badge.svg)](https://codespaces.new/ministryofjustice/modernisation-platform-environments) -- Visual Studio Code +## Locally - - Dev Containers Extention +> [!WARNING] +> This has only been tested on macOS -## Running +### Prerequisites -### GitHub Codespaces +- Docker -Launch from GitHub +- Visual Studio Code + + - Dev Containers Extention -### Locally +### Steps 1. Ensure prerequisites are met From 680937858a3dfec5cae5844f902a3c99ea6bcb1b Mon Sep 17 00:00:00 2001 From: Jacob Woffenden <jacob@woffenden.io> Date: Mon, 25 Nov 2024 11:00:15 +0000 Subject: [PATCH 2/3] Add button --- .devcontainer/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 1d71e3c733e..5aac7ac37f4 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -9,7 +9,7 @@ You can run this locally, or with [GitHub Codespaces](https://docs.github.com/en ## GitHub Codespaces -To launch a GitHub Codespace, use the button below: +To launch a GitHub Codespace, use the button below [![Open in Codespace](https://github.com/codespaces/badge.svg)](https://codespaces.new/ministryofjustice/modernisation-platform-environments) @@ -28,6 +28,8 @@ To launch a GitHub Codespace, use the button below: ### Steps +[![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/modernisation-platform-environments) + 1. Ensure prerequisites are met 1. Clone repository From 544a5418d7e0d3dd2749f77b7cab41c0a67deaa4 Mon Sep 17 00:00:00 2001 From: Jacob Woffenden <jacob@woffenden.io> Date: Mon, 25 Nov 2024 11:26:59 +0000 Subject: [PATCH 3/3] Update wording --- .devcontainer/README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 5aac7ac37f4..a175a0a9dcc 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -7,12 +7,6 @@ To assist with working on this repository, the community has configured a [dev c You can run this locally, or with [GitHub Codespaces](https://docs.github.com/en/codespaces/overview). -## GitHub Codespaces - -To launch a GitHub Codespace, use the button below - -[![Open in Codespace](https://github.com/codespaces/badge.svg)](https://codespaces.new/ministryofjustice/modernisation-platform-environments) - ## Locally > [!WARNING] @@ -26,17 +20,18 @@ To launch a GitHub Codespace, use the button below - Dev Containers Extention -### Steps +To launch locally, ensure the prerequisites are met, and then click the button below [![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/modernisation-platform-environments) -1. Ensure prerequisites are met +## GitHub Codespaces -1. Clone repository +> [!IMPORTANT] +> GitHub Codespaces are not currently paid for by the Ministry of Justice and are subject to the quotas [here](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts) -1. Open repository in Visual Studio Code +To launch a GitHub Codespace, click the button below -1. Reopen in container +[![Open in Codespace](https://github.com/codespaces/badge.svg)](https://codespaces.new/ministryofjustice/modernisation-platform-environments) ## Tools