From 242d91545288c5db012854500aead1b355cabb10 Mon Sep 17 00:00:00 2001 From: jon brookes Date: Sat, 16 Aug 2025 18:03:53 +0100 Subject: [PATCH] Enhance development environment guide by adding pre-flight checks and updating required executables for Windows users --- src/content/docs/guides/dev-env.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/content/docs/guides/dev-env.md b/src/content/docs/guides/dev-env.md index 2bd4a35..181e99d 100644 --- a/src/content/docs/guides/dev-env.md +++ b/src/content/docs/guides/dev-env.md @@ -3,6 +3,8 @@ title: Local Development Environment description: A guide to checking a local environment. --- +## Pre Flight Checks + Run `dev-pre-flight-checks.sh` command line tool with ```bash @@ -13,9 +15,19 @@ Alternatively, download https://codeberg.org/headshed/infctl-cli/raw/branch/main the following executables are checked to be in your `$PATH`: -"infctl" "pwgen" "kubectl" "k3d" "helm" "jq" "docker" +"infctl" "pwgen" "kubectl" "k3d" "helm" "jq" "docker" "vagrant" "git" -if any of these are missing, a development environment cannot be created. +if any of these are missing, an MVK development environment may fail. + +### Note for windows users + +Linux and Mac already have `bash` and often `git` installed as part of a default developer environment, however Windows may not, so for MVK, we can use [Git Bash](https://git-scm.com/downloads), so check you have this installed on Windows if not already. + +Windows will need `jq` to be installed by [downloading](https://jqlang.org/download/) it or installing with `winget install jqlang.jq.` + +Use Git Bash from here on to run `infctl` commands as they will require for there to be a bash shell to run any of its plugins. + +## Install Pre-Requisites `infctl` - see [quick start](/guides/quick-start/)