chore: update information about VM persistence #251
Conversation
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
||
| Everything in `/workspaces/workspace` is guaranteed to be persisted between reboots, hibernations and forks. We persist the workspace folder and the Docker engine state, like images, volumes, etc. | ||
|
|
||
| Every file change outside of `/workspaces/workspace` will usually be persisted, but there is a chance that those changes will be cleared. |
There was a problem hiding this comment.
This is the other way round. Outside the workspace the changes are not usually persisted. It might be persisted between restarts but there is no guarantee. So maybe we can remove this line.
| @@ -38,25 +36,36 @@ Note that, the first time you import a project to CodeSandbox, it can take longe | |||
|
|
|||
| ## Persistence | |||
|
|
|||
| Everything you save in `/project` is guaranteed to be persisted between reboots, hibernations and forks. Every file change outside of `/project` will usually be persisted, but there is a chance that those changes will be cleared. | |||
| We use [Dev Containers](https://codesandbox.io/docs/learn/environment/devcontainers) by default for all repositories and Devboxes. Your project is under `/workspaces/workspace`, and your home folder is under `/root`. Under the hood, the paths are in `/project`. | |||
There was a problem hiding this comment.
Maybe we can define workspace as the directory where the code is stored and it defaults to /workspaces/workspace. Then we do not have to repeat /workspaces/workspace in the next few lines (Those references might confuse users whose workspace is not in /workspaces/workspace).
|
|
||
| Every file change outside of `/workspaces/workspace` will usually be persisted, but there is a chance that those changes will be cleared. | ||
|
|
||
| Your project folder lives in `/workspaces/workspace/<repo-name>`; your home folder lives in `/workspaces/workspace/home/<username>`; your home folder is inaccessible to other users. |
There was a problem hiding this comment.
The project folder is the workspace folder (which defaults to /workspaces/workspace). And the user folder is /root. This line is no longer relevant for persistence as we already mention that workspace folder is persisted.
|
|
||
| Your project folder lives in `/workspaces/workspace/<repo-name>`; your home folder lives in `/workspaces/workspace/home/<username>`; your home folder is inaccessible to other users. | ||
|
|
||
| If your branch or Devbox has not been accessed for a certain period (explained below), we delete the contents of `/workspaces/workspace`. This means that the next time you start this branch again, we will reinitialize `/workspaces/workspace` by doing a fresh clone. |
There was a problem hiding this comment.
We delete the contents of the workspace, but take a backup of uncommitted changes for repos and all code in devboxes (other than the ones in .gitignore). Maybe we can merge this line and the next one.
|
Updated based on Joji's suggestions |
Preview here. Needs a review of the technical accuracy of the changes, as I picked them up from a Slack thread.