Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: add file sync to coder desktop docs#17463

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.

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

Already on GitHub?Sign in to your account

Merged
EdwardAngert merged 10 commits intomainfrom16869-desktop-file-sync
May 14, 2025

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngertEdwardAngert commentedApr 17, 2025•
edited
Loading

closes#16869

section could use more about:

  • sync direction options?
  • how to resolve conflicts
  • EA --> Beta

preview

@EdwardAngertEdwardAngert added the docsArea: coder.com/docs labelApr 17, 2025
@EdwardAngertEdwardAngert self-assigned thisApr 17, 2025
@matifali
Copy link
Member

Sync direction is bi directional and settings for this are currently out of scope.

Merge conflict resolution is also out of scope for now.

@ethanndickson to confirm please.

@ethanndickson
Copy link
Member

ethanndickson commentedApr 18, 2025•
edited
Loading

Sync direction is bi directional and settings for this are currently out of scope.
Merge conflict resolution is also out of scope for now.

Correct. We're using thetwo-way-safeMutagen bi-directional sync mode:

In this bidirectional synchronization mode, both endpoints are treated with equal precedence, and conflicts are only automatically resolved if they don’t result in data loss (for example, modifications on one endpoint can can overwrite deletions of the corresponding content on the other endpoint). If conflicts can’t be automatically resolved, they are stored in the session state (and can be enumerated with the mutagen sync list command).

There's no easy way to configure Coder Desktop to use another of the Mutagen modes (i.e. non-bidi sync) right now.

For conflicts that aren't automatically resolved, the user can just delete the conflicting file on the side that has the version they'd like to discard.

One thing to note is that VCS directories (namely,.git/) are excluded from all sync sessions. See theMutagen documentation as to why. A GitHub repo should be cloned onto whichever side you would like to run git commands from. You won't be able to run them from both sides.

@matifali
Copy link
Member

For conflicts that aren't automatically resolved, the user can just delete the conflicting file on the side that has the version they'd like to discard.

@EdwardAngert, this is a good enough explanation to put in the docs for conflict resolution.

@matifali
Copy link
Member

matifali commentedApr 18, 2025•
edited
Loading

@EdwardAngert, I feel the page is too long.
I suggest we split this into multiple pages. WDYT?

Coder Desktop/├── Installation and Setup├── Coder Connect└── File Sync

@EdwardAngert
Copy link
ContributorAuthor

@EdwardAngert, I feel the page is too long. I suggest we split this into multiple pages. WDYT?

Coder Desktop/├── Installation and Setup├── Coder Connect└── File Sync

I think we're close to that

I think the screenshots make this feel longer than it is + file sync would look pretty lonely on its own page, but we might be able to cut it into

  1. set up
  2. use

but I'm having some trouble with "Coder Connect" because it doesn't really tell a user what it does, and if I'm a Coder Desktop user, I don't really know what Coder Connect is aside from being the button I click. Splitting things up should be another PR

@EdwardAngertEdwardAngert marked this pull request as ready for reviewApril 21, 2025 19:56
Comment on lines 165 to 189
## Sync a local directory with your workspace

Coder Desktop file sync provides bidirectional synchronization between a local directory and your workspace.
You can work offline, add screenshots to documentation, or use local development tools while keeping your files in sync with your workspace.

1. Create a new local directory.

If you select an existing clone of your repository, Desktop will recognize it as conflicting files.

1. In the Coder Desktop app, select **File sync**.

![Coder Desktop File Sync screen](../../images/user-guides/desktop/coder-desktop-file-sync.png)

1. Select the **+** in the corner to select the local path, workspace, and remote path, then select **Add**:

![Coder Desktop File Sync add paths](../../images/user-guides/desktop/coder-desktop-file-sync-add.png)

1. File sync clones your workspace directory to your local directory, then watches for changes:

![Coder Desktop File Sync watching](../../images/user-guides/desktop/coder-desktop-file-sync-watching.png)

File sync excludes version control system directories like `.git/` from synchronization, so keep your Git-cloned repository wherever you run Git commands.
This means that if you use an IDE with a built-in terminal to edit files on your remote workspace, that should be the Git clone and your local directory should be for file syncs.

If you encounter a synchronization conflict, delete the conflicting file that contains changes you don't want to keep.
Copy link
Member

Choose a reason for hiding this comment

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

Thoughts on adding a Windows section here, too?

Copy link
Member

Choose a reason for hiding this comment

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

Can we also add a note or two on what Ethan described here in thecomment?

Copy link
ContributorAuthor

@EdwardAngertEdwardAngertApr 22, 2025•
edited
Loading

Choose a reason for hiding this comment

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

the mutagen stuff?

I guess we could - I skipped it for user-facing documentation. it's good for us to know how it works or why it could change one day, but there doesn't seem to be anything a Desktop user could do about it. Is there? Mutagen docs@ethanndickson linked to say that the git stuff should be excluded, so even if there is a workaround, we're probably safer not suggesting it

ethanndickson reacted with thumbs up emoji

Choose a reason for hiding this comment

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

One thing users might not pick up on is that they can hover over theStatus (or either path, or the size) for a longer description of it, or, in the case of file sync conflicts, to see what files are conflicting. Can one of these screenshots include the user hovering over the status?

EdwardAngert reacted with thumbs up emoji
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I added a line to the steps about the mouseover, and added aFile sync conflicts section in42e7648

@github-actionsgithub-actionsbot added the staleThis issue is like stale bread. labelApr 30, 2025
@matifalimatifali removed the staleThis issue is like stale bread. labelApr 30, 2025
@EdwardAngert
Copy link
ContributorAuthor

@matifali@ethanndickson is there anything we want to add to this PR before release?@ethanndickson would a windows screenshot add anything? do you have one on hand?

Copy link
Member

@ethanndicksonethanndickson left a comment

Choose a reason for hiding this comment

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

Looking good, just one comment on something that's changed.

@deansheather is there any Windows functionality that you think we should include a screenshot of? Both platforms are pretty much identical feature-wise, so I think it's fine like this.

Comment on lines +140 to +141
> [!NOTE]
> Currently, the Coder IDE extensions for VSCode and JetBrains create their own tunnel and do not utilize the Coder Connect tunnel to connect to workspaces.
Copy link
Member

Choose a reason for hiding this comment

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

This is no longer true if the user is running a Coder deployment of version 2.22 or later. IDE extensions connected to older server versions still have this issue.

Copy link
Member

Choose a reason for hiding this comment

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

Better to remove the note instead of making it more explicit to explain the difference in behaviour.

Copy link
Member

Choose a reason for hiding this comment

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

Why's that?

Copy link
Member

Choose a reason for hiding this comment

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

I am in favor of simpler docs. Eventually, all users, when upgraded to version 2.22, will be using the Coder Connect tunnels. So IMO its better to leave this out.

Or we can say, as per version 2.22 of Coder IDE, extensions can also make use of the Coder Connect tunnel to improve performance

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Suggested change
>[!NOTE]
>Currently, the Coder IDE extensions for VSCode and JetBrains create their own tunnel and do not utilize the Coder Connect tunnel to connect to workspaces.
>[!NOTE]
>For Coder versions v2.21.3 and earlier: the Coder IDE extensions for VSCode and JetBrains create their own tunnel and do not utilize the Coder Connect tunnel to connect to workspaces.

ethanndickson reacted with thumbs up emoji
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

@matifali - does this feel like a good balance?

for now, because it's all but the newest version, I think we need to have some indication of who's affected

matifali reacted with thumbs up emoji
Copy link
Member

Choose a reason for hiding this comment

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

It's perfect.

@deansheather
Copy link
Member

They're pretty much the same but with different UIs. The latest release on GitHub has it all included if you want to take a look@EdwardAngert

EdwardAngert reacted with thumbs up emoji

@matifali
Copy link
Member

@EdwardAngert can you also move the docs labels toBeta in same PR?

@EdwardAngert
Copy link
ContributorAuthor

@EdwardAngert can you also move the docs labels toBeta in same PR?

@matifali I thought I caught theearly access tags - did you find one I missed?

2025-05-05_23-48-15

matifali reacted with thumbs up emoji

@matifali
Copy link
Member

It's all good.

EdwardAngert reacted with thumbs up emoji

@EdwardAngertEdwardAngert merged commit74934e1 intomainMay 14, 2025
33 checks passed
@EdwardAngertEdwardAngert deleted the 16869-desktop-file-sync branchMay 14, 2025 14:05
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsMay 14, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@matifalimatifalimatifali approved these changes

@ethanndicksonethanndicksonethanndickson approved these changes

Assignees

@EdwardAngertEdwardAngert

Labels
docsArea: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: Coder Desktop - file sync
4 participants
@EdwardAngert@matifali@ethanndickson@deansheather
[8]ページ先頭
©2009-2025 Movatter.jp