Skip to content

Commit 7b3ff4e

Browse files
committed
Adding trloft's changes
1 parent 8ae8f3b commit 7b3ff4e

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

  • docs/pages/configuration/dev/files

docs/pages/configuration/dev/files/sync.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -212,12 +212,12 @@ uploadExcludeFile: "" # Do not load exclude paths from a file
212212
Sometimes it is useful to execute commands after the sync uploads files/directories between the local filesystem and the container.
213213

214214
:::warning
215-
Make sure that post-sync commands will **<u>not</u>** trigger a new sync process which could lead to an **endless loop**.
215+
Make sure that post-sync commands will **<u>not</u>** trigger a new sync process. This could lead to an **endless loop**.
216216
:::
217217

218218
### `startContainer`
219219

220-
The `startContainer` option can be used to delay starting a container until sync has finished uploading all files initially. This is very useful if your container entrypoint requires certain files. Needs `command` to be set as otherwise DevSpace doesn't know which command to start.
220+
The `startContainer` option can be used to delay starting a container until sync has finished uploading all files initially. This is very useful if your container entrypoint requires certain files. This option requires `command` to be set; otherwise, DevSpace will not know which command to start.
221221

222222
#### Example: Enable Container start
223223
```yaml
@@ -247,7 +247,7 @@ If multiple sync paths with `startContainer` exist, DevSpace will wait for all t
247247
The `restartContainer` option expects a boolean which defines if DevSpace should restart the container every time either a single file or even a batch of files have been uploaded to the container using file sync.
248248

249249
:::caution Restart Helper Required
250-
Setting `restartContainer: true` requires to set `command: ["my", "container", "entrypoint"]`. Otherwise, DevSpace doesn't know which command to restart.
250+
Setting `restartContainer: true` requires you to also set `command: ["my", "container", "entrypoint"]`. Otherwise, DevSpace will not know which command to restart.
251251
:::
252252

253253
:::note When not to use this option
@@ -411,7 +411,6 @@ initialSync: mirrorLocal
411411
```
412412

413413
#### Example: Configuring Initial Sync
414-
<<<<<<< HEAD
415414

416415
```yaml
417416
deployments:
@@ -434,7 +433,7 @@ dev:
434433
**Explanation:**
435434
With this configuration, `devspace dev` would do the following:
436435
- DevSpace would start port-forwarding and file synchronzation.
437-
- Initial sync would be started automatically.
436+
- Initial sync is started automatically.
438437
- The first sync config section would synchronize all files except files within `node_modules/`. This means that during initial sync, all remote files that are not existing locally would be deleted and other files would be updated to the most recent version.
439438
- The second sync config section would only synchronize files within `node_modules/` and because of `initialSync: preferRemote`, DevSpace would download all remote files which are not present on the local filesystem and override all local files which are different than the files within the container.
440439

@@ -503,8 +502,8 @@ dev:
503502
upload: 100 # 100 KB/s
504503
```
505504
**Explanation:**
506-
- Downloading files from the container to the local filesystem would be limited to a transfer speed of `200 KB/s`.
507-
- Upload files from the local filesystem to the container would be limited to a transfer speed of `100 KB/s`.
505+
- Downloading files from the container to the local filesystem is limited to a transfer speed of `200 KB/s`.
506+
- Upload files from the local filesystem to the container is limited to a transfer speed of `100 KB/s`.
508507

509508
### `bandwidthLimits.upload`
510509
The `bandwidthLimits.upload` option expects an integer representing the max file upload speed in KB/s, e.g. `upload: 100` would limit the file sync to a upload speed of `100 KB/s`.
@@ -520,7 +519,7 @@ By default, the file synchronization algorithm uses the maximum bandwidth possib
520519

521520
### `polling`
522521

523-
Polling specifies if the DevSpace helper should traverse over all watched files and folders periodically in the container to identify file changes. By default, DevSpace will use [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) to detect changes which is more efficient, however sometimes it might be unsupported or not feasible in certain situations, in which polling might be preferred.
522+
Polling specifies if the DevSpace helper should traverse over all watched files and folders periodically in the container to identify file changes. By default, DevSpace uses [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) to detect changes. This can be more efficient, however, sometimes it might be unsupported or not feasible in certain situations, in which case, polling might be preferred.
524523

525524
```yaml
526525
deployments:

0 commit comments

Comments
 (0)