From aec013b353a3201e4bdaf482fdfb2594c0110d94 Mon Sep 17 00:00:00 2001 From: David Elliott Date: Tue, 27 Apr 2021 10:12:43 +0100 Subject: [PATCH] Add readme Explaining the purpose of the environments repo and how to request a new environment. --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0826d50ec0c..365904a06a4 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,11 @@ -# Ministry of Justice Template Repository +# Modernisation Platform Environments -Use this template to [create a repository] with the default initial files for a Ministry of Justice Github repository, including: +## Introduction -* The correct LICENSE -* Github actions -* .gitignore file +This repository contains the Modernisation Platform infrastructure and workflow for user environments (AWS accounts). -Once you have created your repository, please: +Here you can add infrastructure to your environment with [Terraform](https://www.terraform.io/). This currently is manually deployed to your environment by a Modernisation Platform engineer, but we plan to introduce Github workflows to automate this. -* Edit the copy of this README.md file to document your project -* Grant permissions to the appropriate MoJ teams -* Setup branch protection +To learn more about how the Modernisation Platform works, please see our main repo [modernisation-platform](https://github.com/ministryofjustice/modernisation-platform), or our [user guidance](https://ministryofjustice.github.io/modernisation-platform) -[create a repository]: https://github.com/ministryofjustice/template-repository/generate +To request an environment, a new feature, or to report a bug, please [create an issue](https://github.com/ministryofjustice/modernisation-platform/issues/new/choose) on our main repo using the relevant issue template.