docs(contrib): note windows symbolic link config

[tczhao]

Fixes #12603

In Windows, setting symlink=true in Git automatically trigger powershell command mklink on all symbolic link files, so they connect properly in windows file system

Setting autocrlf to false prevents line return getting modified causing bash issue

Motivation

Modifications

Verification

[agilgur5]

I believe these can be set automatically in the .gitatrributes if necessary, which would be preferable to docs changes.

autocrlf is usually recommended as auto though

[tczhao]

I believe these can be set automatically in the .gitatrributes if necessary, which would be preferable to docs changes.

autocrlf is usually recommended as auto though

• For the symlink, if we configure it using gitattributes, we have to specify every single symbolic files but with git config core.symlinks, it will automatically set up symlink for all files, and we don't need to maintain this file list.

• For autocrlf, I think setting to auto if only useful if we develop frontend without running the backend. Running the argo-workflow backend in Windows requires dev container or wsl2; both require line return using LF. Otherwise, bash commands won't work.
  Since in the running-locally guide we always run the backend and frontend together, I think setting autocrlf=false for this repo is a valid approach.

[agilgur5]

• For the symlink, if we configure it using gitattributes, we have to specify every single symbolic files but with git config core.symlinks, it will automatically set up symlink for all files, and we don't need to maintain this file list.

Looks like core.symlinks is true by default?

• [...] Since in the running-locally guide we always run the backend and frontend together, I think setting autocrlf=false for this repo is a valid approach.

So it would make sense to set this in the .gitattributes then, no?

Also, I do sometimes run the front-end build or install separately (not the devserver, that I do run together), but I'm either native on Mac or in the devcontainer.

[agilgur5]

Looks like core.symlinks is true by default?

Stumbled upon on an old thread I hadn't finished reading -- another contributor there also had to enable core.symlinks. I'm wondering if it's maybe disabled on Windows installations by default? (though that might depend on where you installed from too)

[tczhao]

Looks like core.symlinks is true by default?

Stumbled upon on an old thread I hadn't finished reading -- another contributor there also had to enable core.symlinks. I'm wondering if it's maybe disabled on Windows installations by default? (though that might depend on where you installed from too)

I had a quick look, and the latest Git installation in Windows defaults the symlink to enabled. I think we only see this issue if people have been using Git on Windows and never reinstalled it.
Perhaps we could make a comment and workaround label in the issue and close it instead

[agilgur5]

Superseded by #13534