Skip to content

docs: added section on symlinks when using SFS #21712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 6, 2025
Merged

docs: added section on symlinks when using SFS #21712

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5422eb3
Added section on symlinks in SFS
chaomonica Jan 3, 2025
12d550a
Removed shorthand
chaomonica Jan 3, 2025
34a5839
Update content/manuals/desktop/features/synchronized-file-sharing.md
chaomonica Jan 6, 2025
8a176f9
Update content/manuals/desktop/features/synchronized-file-sharing.md
chaomonica Jan 6, 2025
ecb462c
Moved section into bullet point
chaomonica Jan 6, 2025
1e1f6b2
Added sentence for mac and linux users
chaomonica Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/manuals/desktop/features/synchronized-file-sharing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@

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

Check failure on line 83 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 83, "column": 13}}}, "severity": "ERROR"}
Copy link
Contributor

@aevesdocker aevesdocker Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@chaomonica chaomonica Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aevesdocker I will format this into a bullet point. Thank you for pointing this out!


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.

Check failure on line 85 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'does'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'does'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 85, "column": 14}}}, "severity": "ERROR"}

Check failure on line 85 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'permissions'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'permissions'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 85, "column": 28}}}, "severity": "ERROR"}

Check failure on line 85 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 85, "column": 59}}}, "severity": "ERROR"}

Check failure on line 85 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'attempts'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'attempts'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 85, "column": 84}}}, "severity": "ERROR"}

Check failure on line 85 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 85, "column": 112}}}, "severity": "ERROR"}

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.

Check failure on line 87 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 87, "column": 22}}}, "severity": "ERROR"}

Check failure on line 87 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'practices'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'practices'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 87, "column": 191}}}, "severity": "ERROR"}

Check failure on line 87 in content/manuals/desktop/features/synchronized-file-sharing.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.

Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'links'.", "location": {"path": "content/manuals/desktop/features/synchronized-file-sharing.md", "range": {"start": {"line": 87, "column": 238}}}, "severity": "ERROR"}
Copy link
Contributor

@aevesdocker aevesdocker Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this just an issue for Windows users? Is there an equivalent docs set for Mac users we can add?

Copy link
Contributor Author

@chaomonica chaomonica Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aevesdocker This is just an issue for Windows users and there is no equivalent docs set for Mac users. Thanks!

Copy link
Contributor

@aevesdocker aevesdocker Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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'?

Copy link
Contributor Author

@chaomonica chaomonica Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aevesdocker Oops, actually my mistake - let me actually test this on Mac.

Copy link
Contributor Author

@chaomonica chaomonica Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aevesdocker I have added an additional sentence for Linux and Mac users. Thank you for checking!


## Known issues

- Changes made to `.syncignore` don't lead to immediate deletions unless the file share is recreated. In other words, files that are newly ignored due to modifications in the `.syncignore` file remain in their current location, but are no longer updated during synchronization.
Expand Down