From a34a92ad1423365aaed72b9b383e52ae00f081b0 Mon Sep 17 00:00:00 2001 From: Mason Malone <651224+MasonM@users.noreply.github.com> Date: Sun, 6 Apr 2025 10:24:46 -0700 Subject: [PATCH] fix: incorrect reference to `volumes` attribute `mounts` is not a valid attribute in Docker Compose files. I'm assuming this is a typo for [`volumes`](https://docs.docker.com/reference/compose-file/services/#volumes). Signed-off-by: Mason Malone <651224+MasonM@users.noreply.github.com> --- docs/specs/devcontainer-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/specs/devcontainer-reference.md b/docs/specs/devcontainer-reference.md index 0944621a..c4aeab7a 100644 --- a/docs/specs/devcontainer-reference.md +++ b/docs/specs/devcontainer-reference.md @@ -157,7 +157,7 @@ Inside the container this mount defaults to `/workspace`. ## workspaceFolder and workspaceMount -The default mount point for the source code can be set with the `workspaceMount` property for **image** and **dockerfile** scenarios or using the built in `mounts` property in **Docker Compose** files. This folder should point to the root of a repository (where the `.git` folder is found) so that source control operations work correctly inside the container. +The default mount point for the source code can be set with the `workspaceMount` property for **image** and **dockerfile** scenarios or using the built in [`volumes` attribute](https://docs.docker.com/reference/compose-file/services/#volumes) in **Docker Compose** files. This folder should point to the root of a repository (where the `.git` folder is found) so that source control operations work correctly inside the container. The `workspaceFolder` can then be set to the default folder inside the container that should used in the container. Typically this is either the mount point in the container, or a sub-folder under it. Allowing a sub-folder to be used is particularly important for monorepos given you need the `.git` folder to interact with source control but developers are typically are interacting with a specific sub-project within the overall repository.