Skip to content

Commit

Permalink
Revise sync status documentation with additional file provider icons.
Browse files Browse the repository at this point in the history
  • Loading branch information
dkocher committed Nov 30, 2023
1 parent 8fd5fb4 commit 204d0b8
Showing 1 changed file with 57 additions and 10 deletions.
67 changes: 57 additions & 10 deletions mountainduck/connect/integrated.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,69 @@ You can access files in _Integrated_ connect mode without being always connected

Files and folders on a mounted volume have a status icon overlay in _File Explorer_ (Windows) and _Finder_ (macOS).

`````{tabs}
````{group-tab} macOS
### ![](../_images/overlay_uptodate.png) Up to Date
The file or the contents of a directory has been opened and downloaded to your computer and therefore currently synced with the server or cloud storage. The file takes disk space on your computer and can always be opened even when no connection to the server or cloud storage is possible. New files in a directory on the remote server will appear as *Online Only* and are not downloaded automatically. Files copied to a volume are kept cached by default.

An additional icon next to the filename is displayed in Finder denoting the synchronization status in _Integrated_ connect mode.
```{note}
Files can be purged automatically from the cache when not accessed or the cache size limit is exceeded. Refer to [Cache Limitations](../preferences.md#cache-limitations).
```

### ![](../_images/overlay_infinite.png) Online Only
The file can only be opened when a connection to the server or cloud storage can be made. The file does not take any space on your computer. The file is downloaded on demand when you open it.

:::{admonition} macOS only
:class: note
```{image} ../_images/File_Provider_Online_Only.png
:alt: File Provider Icon
:width: 24px
:align: left
```
Click this additional icon displayed next to the filename in Finder.app to request the download of the file.
:::

### ![](../_images/File_Provider_Online_Only.png) Online Only
### ![](../_images/File_Provider_Ignored.png) Ignored
### ![](../_images/File_Provider_Error.png) Sync Error
### ![](../_images/overlay_sync.png) In Sync
The file or folder is selected to be synced with the server or cloud storage to always keep offline. The file takes disk space on your computer and can always be opened even when no connection to the server or cloud storage is possible. New files in a directory on the remote server will be downloaded automatically.

```{tip}
Files explicitly selected to keep offline are **not** automatically purged. Refer to [Cache Limitations](../preferences.md#cache-limitations).
```

### ![](../_images/overlay_syncing.png) Sync in Progress
The file or folder is currently syncing with the server or cloud storage. Check the menu with the sync status for current download or upload progress.

````
````{group-tab} Windows
### ![](../_images/overlay_error.png) Sync Error
Files that failed to sync after changes. You are missing permission to write to the file or another problem occurred. Please contact your web hosting service provider for assistance. To resolve the error, move the file to your local disk, and reload the directory. Refer to [Sync Conflicts](sync.md#sync-conflicts) for possible error scenarios. You can try to repeat the failed transfer by selecting *Mountain Duck → Retry* in the [context menu](sync.md#context-menu-options). If a sync error cannot be solved using *Mountain Duck → Retry* because the server does not allow the operation (i.e. due to a permission issue), you can resolve the error state on the file or folder by

- Move the file or folder to another location on the volume
- Delete the file or folder
- To upload files to a target directory no longer existing on the server, you have to move the files to a location found on the server.

:::{admonition} macOS only
:class: note
```{image} ../_images/File_Provider_Ignored.png
:alt: File Provider Icon
:width: 24px
:align: left
```
This additional icon displayed next to the filename in Finder.app indicates the file is not synced.
:::

### ![](../_images/overlay-pause.png) Sync Paused
The file or folder is pending syncing with the server but synchronization has been [paused](#pause-sync).

### ![](../_images/overlay_ignored.png) Ignored
The file or folder is only saved in local cache and not synced. New _Folders_, empty files and files matching [excluded filename patterns](../issues/index.md#filenames) are not uploaded. Folders are uploaded after being renamed.

:::{admonition} macOS only
:class: note
```{image} ../_images/File_Provider_Error.png
:alt: File Provider Icon
:width: 24px
:align: left
```
This additional icon displayed next to the filename in Finder.app indicates a sync error for the file.
:::

````
`````

## Sync Progress

Expand Down

0 comments on commit 204d0b8

Please sign in to comment.