Skip to content

Commit 32aa6c4

Browse files
joyeecheungbnb
andauthored
fixup! doc: update devcontainer.json and add documentation
Co-authored-by: Tierney Cyren <[email protected]>
1 parent 71f5751 commit 32aa6c4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/contributing/using-devcontainer.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Launch VS Code and open the cloned Node.js repository.
5454
VS Code will build the Dev Container based on the configuration file. This may take some time depending
5555
on your internet connection and system performance.
5656

57-
After the container is built, it will start automatically. By default it will run `git restore-mtime` to
57+
After the Dev Container is built, it will start automatically. By default it will run `git restore-mtime` to
5858
restore the modification times of the files in the working directory, in order to keep the build cache valid,
5959
and you will see something like this in the terminal.
6060

@@ -68,11 +68,12 @@ This may take a few seconds. Wait until it finishes before you open a new termin
6868

6969
### 5. Build your changes
7070

71-
Once the container is running, you can open a terminal in VS Code and run the build commands. By default, your
72-
local repository is mounted inside a checkout in the container, so any changes you make will be reflected in
73-
the container environment.
71+
Once the Dev Container is running, you can open a terminal in VS Code and run the build commands. By default,
72+
your local repository is mounted inside a checkout in the Dev Container, so any changes you make will be reflected
73+
in the container environment.
7474

75-
In the Dev Container, the necessary dependencies are already installed. For better developer experience, the
75+
In the Dev Container, the necessary dependencies are already installed and Node.js has already been
76+
compiled, so a usable cache will exist. For better developer experience, the
7677
build tool used in the Dev Container is `ninja`, instead of `make`. See
7778
[Building Node.js with Ninja](./building-node-with-ninja.md) for more details on using `ninja` to build Node.js.
7879

@@ -107,19 +108,18 @@ so by running the following command in the terminal on your host machine:
107108
docker pull nodejs/devcontainer:nightly
108109
```
109110

110-
The default configuration creates a volume to cache the build outputs between container restarts. If you wish to clear
111+
The default configuration creates a volume to cache the build outputs between Dev Container restarts. If you wish to clear
111112
the build cache, you can do so by deleting the volume named `node-devcontainer-cache`.
112113

113114
```bash
114115
docker volume rm node-devcontainer-cache
115116
```
116117

117-
To rebuild the container in VS Code, open the command palette and select
118+
To rebuild the Dev Container in VS Code, open the command palette and select
118119
`Dev Containers: Rebuild and Reopen in Container`.
119120

120121
## Further Reading
121122

122123
* [Visual Studio Code Dev Containers Documentation](https://code.visualstudio.com/docs/remote/containers)
123-
* If you want to propose changes to the official nightly Dev Container image, the repository is
124-
[nodejs/devcontainer](https://github.com/nodejs/devcontainer) which contains the nightly workflows and
125-
the Dockerfile.
124+
* If you want to propose changes to the official Node.js Nightly Dev Container image, feedback is welcome at [nodejs/devcontainer](https://github.com/nodejs/devcontainer). There, you can find
125+
the Dockerfile and automated nightly workflows.

0 commit comments

Comments
 (0)