From 3ad5f73a73d78136a0c08e780ed255e7cd7a9529 Mon Sep 17 00:00:00 2001 From: Jeyachandran Rathnam Date: Thu, 21 Sep 2023 03:45:11 +0000 Subject: [PATCH] Contributing docs for Windows --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f22169f0..fd9b5e802 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,14 @@ HYPERDX_API_KEY= docker compose -f ./docker-compose The core services are all hot-reloaded, so you can make changes to the code and see them reflected in real-time. +### Windows + +If you are running WSL 2, Hot module reload on Nextjs (Frontend) does not work out of the box on windows when run natively on docker. The fix here is to open project directory in WSL and run the above docker compose commands directly in WSL. Note that the project directory should not be under /mnt/c/ directory. You can clone the git repo in /home/{username} for example. + +To develop from WSL, follow instructions [here](https://code.visualstudio.com/docs/remote/wsl). + +## Additional support + If you need help getting started, [join our Discord](https://discord.gg/FErRRKU78j) and we're more than happy to -get you set up! +get you set up! \ No newline at end of file