From 59bb2042947a1ce12e7b1ed4ddb4e4072a742fd1 Mon Sep 17 00:00:00 2001 From: Alex Garel Date: Tue, 10 Dec 2024 15:57:24 +0100 Subject: [PATCH] docs: some more pre-requisite for docker desktop (#11100) After debugging install on Mac --- docs/dev/how-to-quick-start-guide.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/dev/how-to-quick-start-guide.md b/docs/dev/how-to-quick-start-guide.md index 3c17e00e776ae..38c88b69c685f 100644 --- a/docs/dev/how-to-quick-start-guide.md +++ b/docs/dev/how-to-quick-start-guide.md @@ -39,14 +39,21 @@ The process of cloning the repository will create a number of symbolic links whi Make sure you also activated the [Developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) on your device. -### Windows Subsystem for Linux (WSL) Prequisites +### Windows Subsystem for Linux (WSL) Prerequisites Ensure that you have WSL installed on your Windows machine. For instructions on how to do so, you can follow [Microsoft's guide to install WSL](https://learn.microsoft.com/en-us/windows/wsl/install). After succcessfully installing WSL, you need to set up your Linux distribution and install Docker on it: - Go to the Microsoft Store and install [Ubuntu](https://www.microsoft.com/store/productId/9PDXGNCFSCZV?ocid=pdpshare) as your Linux distribution - Open Ubuntu and execute the commands/instructions specified in [Installing Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/) (**NOTE: this is NOT the same thing as Docker for Desktop) -- Restart your computer to ensure all changes take effect and WSL can properly integrate with Docker +- Restart your computer to ensure all changes take effect and WSL can properly integrate with Docker + +### Docker Desktop Prerequisite + +If you use Docker Desktop: + +- ensure you allow enough memory for your VMs (at least 4G) +- ensure you Enabled host networking (in Resources / Network) ## 2. Fork and clone the repository from GitHub