Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

Commit

Permalink
Merge pull request #95 from microsoft/update-add-def-command
Browse files Browse the repository at this point in the history
Update command name for adding container defintion w/1.36 release
  • Loading branch information
Chuxel committed Jul 3, 2019
2 parents 788913d + 5955fe1 commit 97deb01
Show file tree
Hide file tree
Showing 56 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If the definition is too similar others, consider contributing a PR to improve a

### Anatomy of a Dev Container Definition

The contents of the folders in the `containers` directory ultimately populate the available definitions list shown in the **Remote-Containers: Create Container Configuration File...** command. To make this work, each folder consists of up to three things:
The contents of the folders in the `containers` directory ultimately populate the available definitions list shown in the **Remote-Containers: Add Development Container Configuration Files...** command. To make this work, each folder consists of up to three things:

1. **The container definition itself** - These are the files and folders that will be added to a user's existing project / folder if they select the definition. Typically these files are stored in a `.devcontainer` folder.
2. **Test assets** - While you are creating your definition, you may need to use a test project to make sure it works as expected. Contributing these files back will also help others that want to contribute to your definition in the future. These files are typically located in a `test-project` folder.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To add a dev container definition in your project, you can either:
1. If this is your first time creating a dev container, follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to configure your machine.
2. Start VS Code and open your project folder.
3. Press <kbd>F1</kbd>
and select either the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands.
and select either the **Remote-Containers: Add Development Container Configuration Files...** or **Remote-Containers: Reopen Folder in Container** commands.
4. Follow the directions and pick one of the existing development container definitions in this repository from the list.

- Or manually copy the contents of one of the folders in the `containers` directory into your project. You should be able to copy just the `.devcontainer` folder and ignore everything else. See the definition's `README` for details.
Expand Down Expand Up @@ -69,7 +69,7 @@ If you want to try a sample project which already has a dev container, check out

### Can I just reuse an existing container image or Docker / Docker Compose configuration?

Yes, if you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the Command Palette (<kbd>F1</kbd>). You'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you prefer, you can also start up the container and [attach to it](https://aka.ms/vscode-remote/containers/attach).
Yes, if you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Add Development Container Configuration Files...** from the Command Palette (<kbd>F1</kbd>). You'll be prompted to select a Dockerfile or Docker Compose file and customize from there. If you prefer, you can also start up the container and [attach to it](https://aka.ms/vscode-remote/containers/attach).

### What is the goal of `devcontainer.json`?

Expand Down
2 changes: 1 addition & 1 deletion container-templates/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Just follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Dart definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion container-templates/dockerfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Just follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Dart definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
4 changes: 2 additions & 2 deletions container-templates/image/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
// Uncomment the next line if you want to add in default container specific settings.json values
// "settings": { "workbench.colorTheme": "Quiet Light" },

// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "uname -a",
// Uncomment the next line to run commands after the container is created - like installing git
// "postCreateCommand": "apt-get update && apt-get install -y git",

// Add the IDs of any extensions you want installed in the array below.
"extensions": []
Expand Down
2 changes: 1 addition & 1 deletion container-templates/image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Just follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Dart definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-ansible/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Next, follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Ansible definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-blockchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Blockchain definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure CLI definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-functions-dotnetcore-2.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Functions & C# (.NET Core 2.1) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-functions-dotnetcore-latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Functions & C# (.NET Core Latest) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-functions-java-8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Functions & Java 8 definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-functions-node-8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Functions & Node.js 8 definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-functions-node-lts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition requires an Azure subscription to use. You can create a [free ac

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Functions & Node.js (latest LTS) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-machine-learning-python-3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Once you have an Azure account, follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Machine Learning definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/azure-terraform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Next, follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Azure Terraform definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/bazel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Just follow these steps:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Dart definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition does not require any special steps to use. Just follow these ste

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the C++ definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/dart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition does not require any special steps to use. Just follow these ste

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Dart definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/debian-9-git/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition does not require any special steps to use. Just follow these ste

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Debian 9 & Git definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/docker-existing-docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Follow these steps to use it:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Existing Docker Compose (Extend) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/docker-existing-dockerfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Follow these steps to use it:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Existing Dockerfile definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/docker-in-docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Docker in Docker Compose definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/docker-in-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Docker in Docker definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/dotnetcore-2.1-fsharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the F# (.NET Core 2.1) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/dotnetcore-2.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the C# (.NET Core 2.1) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/dotnetcore-latest-fsharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the F# (.NET Core Latest) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/dotnetcore-latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the C# (.NET Core Latest) definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This definition does not require any special steps to use. Just follow these ste

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Go definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/java-11/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Java 11 definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/java-12/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyond that, just follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Java 12 definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
2 changes: 1 addition & 1 deletion containers/java-8-tomcat-8.5/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Follow these steps to use the definition:

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
3. Select the Java 8 & Tomcat 8.5 definition.

3. To use latest-and-greatest copy of this definition from the repository:
Expand Down
Loading

0 comments on commit 97deb01

Please sign in to comment.