Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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.
This commit is contained in:
AsociTon 2019-03-15 20:06:54 +05:30 committed by Tim Abbott
parent b58d3a37a7
commit 87f7a578e6
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/development/setup-vagrant.md
View File

@ -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 <https://github.com/zulip/zulip>