From 87f7a578e6efab7594bd73ca6205c0a35c02fde5 Mon Sep 17 00:00:00 2001 From: AsociTon Date: Fri, 15 Mar 2019 20:06:54 +0530 Subject: [PATCH] docs: Document a Windows GitHub Desktop bug. Add the recommendation in docs for not using GitHub Desktop client for zulip code as it has a bug of keeping the symlinks disabled and ignoring any configuration done to re-enable it resulting into failure to identify the received symlinks leading to failing test cases in the zulip development environment. --- docs/development/setup-vagrant.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/development/setup-vagrant.md b/docs/development/setup-vagrant.md index de02b36955..4e77e96c4c 100644 --- a/docs/development/setup-vagrant.md +++ b/docs/development/setup-vagrant.md @@ -270,6 +270,13 @@ winsymlinks:native Now you are ready for [Step 2: Get Zulip Code.](#step-2-get-zulip-code) +(Note: The **GitHub Desktop client** for Windows has a bug where it +will automatically set `git config core.symlink false` on a repository +if you use it to clone a repository, which will break the Zulip +development environment, because we use symbolic links. For that +reason, we recommend avoiding using GitHub Desktop client to clone +projects and to instead follow these instructions exactly.) + ### Step 2: Get Zulip Code 1. In your browser, visit