docs: added section on symlinks when using SFS #21712
Conversation
github-actions
bot
added
the
area/desktop
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks @chaomonica. 2 style guide phrasing nits and a 2 questions
|
|
||
| If your user does not have permissions to create symbolic links and your container attempts to create symbolic links in your file share instance, a **Problem** indicator with an `unable to create symbolic link` error will result. | ||
|
|
||
| See [Create symbolic links](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-10/security/threat-protection/security-policy-settings/create-symbolic-links) for best practices and location of the "Create symbolic links" security policy setting. |
There was a problem hiding this comment.
Is this just an issue for Windows users? Is there an equivalent docs set for Mac users we can add?
There was a problem hiding this comment.
@aevesdocker This is just an issue for Windows users and there is no equivalent docs set for Mac users. Thanks!
There was a problem hiding this comment.
@chaomonica ok great, so in that case, we should make that clear. Perhaps adapting the first sentence with 'As a Windows user, if you don't have the correct permissions......etc'?
There was a problem hiding this comment.
@aevesdocker Oops, actually my mistake - let me actually test this on Mac.
There was a problem hiding this comment.
@aevesdocker I have added an additional sentence for Linux and Mac users. Thank you for checking!
| @@ -80,6 +80,12 @@ Some example of things you might want to add to your `.syncignore` file are: | |||
|
|
|||
| In general, use your `.syncignore` file to exclude items that aren't critical to your workflow, especially those that would be slow to sync or use significant storage. | |||
|
|
|||
| ## Symbolic links | |||
There was a problem hiding this comment.
Instead of having a new section, I think it'd be better to have this as a bullet point in the 'Known issues' section below. WDYT?
There was a problem hiding this comment.
@aevesdocker I will format this into a bullet point. Thank you for pointing this out!
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Description
Based on customer feedback, it was not clear how to resolve the
unable to create symbolic linkerror which can result from a user without permissions to create symbolic links when using a synchronized file share.Related issues or tickets
Reviews