angular-cn/.devcontainer
George Kalpakas ac08a499a3 docs: add info on setting up VSCode remote development using docker containers (#33790)
In f78bda9ff, recommended configuration files were added to be used as
basis for setting up [Remote Development using docker containers][1] in
VSCode. Apparently, I had forgotten to commit the corresponding
`README.md` file.

This commit adds `.devcontainer/README.md` with more info on Remote
Development in VSCode.

[1]: https://code.visualstudio.com/docs/remote/containers

PR Close #33790
2019-11-13 13:33:21 -08:00
..
README.md docs: add info on setting up VSCode remote development using docker containers (#33790) 2019-11-13 13:33:21 -08:00
recommended-Dockerfile docs: add info on setting up VSCode remote development using docker containers (#33790) 2019-11-13 13:33:21 -08:00
recommended-devcontainer.json

README.md

VSCode Remote Development - Developing inside a Containers

This folder contains configuration files that can be used to opt into working on this repository in a Docker container via VSCode's Remote Development feature (see below).

Info on remote development and developing inside a container with VSCode:

Usage

Prerequisite: Install Docker on your local environment.

To get started, read and follow the instuctions in Developing inside a Container. The .devcontainer/ directory contains pre-configured devcontainer.json and Dockerfile files, which you can use to set up remote development with a docker container.

In a nutshell, you need to:

The .devcontainer/devcontainer.json and .devcontainer/Dockerfile files are ignored by git, so you can have your own local versions. We may occasionally update the template files (recommended-devcontainer.json, recommended-Dockerfile), in which case you will need to manually update your local copies (if desired).

You can update and commit the recommended config files (which people use as basis for their local configs), if you find that something is broken, out-of-date or can be improved.

Please, keep in mind that any changes you make will potentially be used by many people on different environments. Try to keep these config files cross-platform compatible and free of personal preferences.