From 4562f8157897f2298ce154977e4421bf8d25aeb8 Mon Sep 17 00:00:00 2001 From: Chuck Lantz Date: Thu, 4 Apr 2019 13:07:49 -0700 Subject: [PATCH] READMEs for all container definitions --- containers/azure-cli/README.md | 30 +++++++++++++++++ containers/azure-functions-node-8/README.md | 28 ++++++++++++++++ containers/azure-hdinsight-python-3/README.md | 28 ++++++++++++++++ .../azure-machine-learning-python-3/README.md | 28 ++++++++++++++++ containers/azure-terraform/README.md | 28 ++++++++++++++++ containers/cpp/README.md | 30 +++++++++++++++++ containers/dart-web/README.md | 31 ++++++++++++++++- .../docker-existing-docker-compose/README.md | 14 +++++++- .../docker-existing-dockerfile/README.md | 10 ++++++ containers/docker-in-docker-compose/README.md | 9 ++++- containers/docker-in-docker/README.md | 11 ++++++- containers/dotnetcore-2.2-fsharp/README.md | 30 +++++++++++++++++ containers/dotnetcore-2.2/README.md | 30 +++++++++++++++++ containers/go/README.md | 30 +++++++++++++++++ containers/java-8-maven/README.md | 30 +++++++++++++++++ containers/javascript-node-8-mongo/README.md | 30 +++++++++++++++++ containers/javascript-node-8/README.md | 30 +++++++++++++++++ containers/kubernetes-helm/README.md | 4 +++ containers/latex/.devcontainer/ignore | 5 --- containers/latex/.vscode/devContainer.json | 7 ---- containers/latex/README.md | 5 --- containers/markdown/README.md | 30 +++++++++++++++++ containers/php-7/README.md | 30 +++++++++++++++++ containers/plantuml/README.md | 33 +++++++++++++++++-- containers/powershell/README.md | 30 +++++++++++++++++ containers/python-2/README.md | 30 +++++++++++++++++ containers/python-3-django/README.md | 30 +++++++++++++++++ containers/python-3-flask-redis/README.md | 30 +++++++++++++++++ containers/python-3/README.md | 30 +++++++++++++++++ containers/ruby-2/README.md | 30 +++++++++++++++++ containers/rust/README.md | 30 +++++++++++++++++ containers/swift-4/README.md | 30 +++++++++++++++++ containers/typescript-node-8/README.md | 30 +++++++++++++++++ 33 files changed, 787 insertions(+), 24 deletions(-) create mode 100644 containers/azure-cli/README.md create mode 100644 containers/azure-functions-node-8/README.md create mode 100644 containers/azure-hdinsight-python-3/README.md create mode 100644 containers/azure-machine-learning-python-3/README.md create mode 100644 containers/azure-terraform/README.md create mode 100644 containers/cpp/README.md create mode 100644 containers/dotnetcore-2.2-fsharp/README.md create mode 100644 containers/dotnetcore-2.2/README.md create mode 100644 containers/go/README.md create mode 100644 containers/java-8-maven/README.md create mode 100644 containers/javascript-node-8-mongo/README.md create mode 100644 containers/javascript-node-8/README.md delete mode 100644 containers/latex/.devcontainer/ignore delete mode 100644 containers/latex/.vscode/devContainer.json delete mode 100644 containers/latex/README.md create mode 100644 containers/markdown/README.md create mode 100644 containers/php-7/README.md create mode 100644 containers/powershell/README.md create mode 100644 containers/python-2/README.md create mode 100644 containers/python-3-django/README.md create mode 100644 containers/python-3-flask-redis/README.md create mode 100644 containers/python-3/README.md create mode 100644 containers/ruby-2/README.md create mode 100644 containers/rust/README.md create mode 100644 containers/swift-4/README.md create mode 100644 containers/typescript-node-8/README.md diff --git a/containers/azure-cli/README.md b/containers/azure-cli/README.md new file mode 100644 index 0000000000..c6d2010545 --- /dev/null +++ b/containers/azure-cli/README.md @@ -0,0 +1,30 @@ +# Azure CLI + +## Summary + +*A basic dev container definitions that demonstrates installation and use of the Azure CLI in a container.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Any | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder and use the content in `test-project` to try things out. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/azure-functions-node-8/README.md b/containers/azure-functions-node-8/README.md new file mode 100644 index 0000000000..62036344eb --- /dev/null +++ b/containers/azure-functions-node-8/README.md @@ -0,0 +1,28 @@ +# Azure Functions w/Node.js v8 + +## Summary + +*A basic dev container definition for building Node.js based Azure Functions in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Azure Functions, Node.js, JavaScript | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/azure-hdinsight-python-3/README.md b/containers/azure-hdinsight-python-3/README.md new file mode 100644 index 0000000000..a70ebb7259 --- /dev/null +++ b/containers/azure-hdinsight-python-3/README.md @@ -0,0 +1,28 @@ +# Azure HDInsight w/Python 3 + +## Summary + +*A basic dev container definition for using Azure HDInsight in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Azure HDInsight, Python | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/azure-machine-learning-python-3/README.md b/containers/azure-machine-learning-python-3/README.md new file mode 100644 index 0000000000..8ec39c63f0 --- /dev/null +++ b/containers/azure-machine-learning-python-3/README.md @@ -0,0 +1,28 @@ +# Azure Machine Learning w/Python 3 + +## Summary + +*A basic dev container definition for using Azure Machine Learning in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Azure Machine Learning, Python | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/azure-terraform/README.md b/containers/azure-terraform/README.md new file mode 100644 index 0000000000..bba0e2b0ef --- /dev/null +++ b/containers/azure-terraform/README.md @@ -0,0 +1,28 @@ +# Azure Terraform + +## Summary + +*A basic dev container that demonstrates the installation and use of Terraform in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Terraform | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/cpp/README.md b/containers/cpp/README.md new file mode 100644 index 0000000000..b9f28c9181 --- /dev/null +++ b/containers/cpp/README.md @@ -0,0 +1,30 @@ +# C++ + +## Summary + +*A basic dev container definition for building C++ apps in container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | C++ | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/dart-web/README.md b/containers/dart-web/README.md index a32968ce5d..73e6f4ad93 100644 --- a/containers/dart-web/README.md +++ b/containers/dart-web/README.md @@ -1 +1,30 @@ -# Dart Dev Container \ No newline at end of file +# Dart - Web + +## Summary + +*A basic dev container definition for developing web applications using Dart in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Dart | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/docker-existing-docker-compose/README.md b/containers/docker-existing-docker-compose/README.md index 3be41f7644..29a750d0ef 100644 --- a/containers/docker-existing-docker-compose/README.md +++ b/containers/docker-existing-docker-compose/README.md @@ -1,4 +1,4 @@ -# Existing Docker Compose +# Existing Docker Compose (Extend) ## Summary @@ -12,6 +12,18 @@ > **Note:** There is also a single [Dockerfile](../docker-existing-dockerfile) variation of this same definition. +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with an existing project that contains a `docker-compose.yml` file: + +1. Copy the `.devcontainer` folder into your project root. +2. Modify the `.devcontainer/dev-container.yml` and `devcontainer.json` files as needed (see comments) +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + ## License Copyright (c) Microsoft Corporation. All rights reserved. diff --git a/containers/docker-existing-dockerfile/README.md b/containers/docker-existing-dockerfile/README.md index 1d17be6a1a..d210ef3eee 100644 --- a/containers/docker-existing-dockerfile/README.md +++ b/containers/docker-existing-dockerfile/README.md @@ -11,6 +11,16 @@ | *Languages, platforms* | Any | > **Note:** There is also a [Docker Compose](../docker-existing-docker-compose) variation of this same definition. +> +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project that contains a `Dockerfile`: + +1. Copy the `.devcontainer` folder into your project root. +2. Modify the `.devcontainer/devcontainer.json` as needed (see comments) +3. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. ## License diff --git a/containers/docker-in-docker-compose/README.md b/containers/docker-in-docker-compose/README.md index fb4984260b..c4b9980ef2 100644 --- a/containers/docker-in-docker-compose/README.md +++ b/containers/docker-in-docker-compose/README.md @@ -18,7 +18,14 @@ Dev containers can be useful for all types of applications including those that ## Usage -No additional setup steps are required, but note that the included `dev-container.dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example: +To use the definition with an existing project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example: ```Dockerfile FROM node:8 diff --git a/containers/docker-in-docker/README.md b/containers/docker-in-docker/README.md index 9143dc8631..f2f8750afb 100644 --- a/containers/docker-in-docker/README.md +++ b/containers/docker-in-docker/README.md @@ -18,7 +18,16 @@ Dev containers can be useful for all types of applications including those that ## Usage -No additional setup steps are required, but note that the included `dev-container.dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example: +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with an existing project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example: ```Dockerfile FROM node:8 diff --git a/containers/dotnetcore-2.2-fsharp/README.md b/containers/dotnetcore-2.2-fsharp/README.md new file mode 100644 index 0000000000..df1abc0e32 --- /dev/null +++ b/containers/dotnetcore-2.2-fsharp/README.md @@ -0,0 +1,30 @@ +# F# + +## Summary + +*A basic dev container definition for using F# in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | F# | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/dotnetcore-2.2/README.md b/containers/dotnetcore-2.2/README.md new file mode 100644 index 0000000000..6e0aff1f20 --- /dev/null +++ b/containers/dotnetcore-2.2/README.md @@ -0,0 +1,30 @@ +# .NET Core v2.2 + +## Summary + +*A basic dev container definition for developing .NET Core applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | .NET Core | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/go/README.md b/containers/go/README.md new file mode 100644 index 0000000000..8e1bd6ef88 --- /dev/null +++ b/containers/go/README.md @@ -0,0 +1,30 @@ +# Go + +## Summary + +*A basic dev container definition for developing Go applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Go | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/java-8-maven/README.md b/containers/java-8-maven/README.md new file mode 100644 index 0000000000..4e41dcda1f --- /dev/null +++ b/containers/java-8-maven/README.md @@ -0,0 +1,30 @@ +# Java v8 and Maven + +## Summary + +*A basic dev container definition for developing Java applications in a container using Maven. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Java, Maven | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/javascript-node-8-mongo/README.md b/containers/javascript-node-8-mongo/README.md new file mode 100644 index 0000000000..259ed4faee --- /dev/null +++ b/containers/javascript-node-8-mongo/README.md @@ -0,0 +1,30 @@ +# Node.js v8 & Mongo DB + +## Summary + +*A basic multi-container dev container definition for building Node.js applications in a container that rely on a Mongo DB. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Docker Compose | +| *Languages, platforms* | Node.js, JavaScript, Mongo DB | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/javascript-node-8/README.md b/containers/javascript-node-8/README.md new file mode 100644 index 0000000000..1b5e70486e --- /dev/null +++ b/containers/javascript-node-8/README.md @@ -0,0 +1,30 @@ +# Node.js v8 & JavaScript + +## Summary + +*A basic dev container definition for developing Node.js applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Node.js, JavaScript | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/kubernetes-helm/README.md b/containers/kubernetes-helm/README.md index 00646da78a..3cd1b61c90 100644 --- a/containers/kubernetes-helm/README.md +++ b/containers/kubernetes-helm/README.md @@ -22,6 +22,10 @@ To get started, follow the appropriate steps below for your operating system. ## Usage +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To try out the definition with an existing project, copy the `.devcontainer` folder into your project root and then follow the OS specific directions below. + ### macOS / Windows Setup 1. Install "Docker Desktop for Mac" / "Docker Desktop for Windows" locally if you have not. diff --git a/containers/latex/.devcontainer/ignore b/containers/latex/.devcontainer/ignore deleted file mode 100644 index 32ec647693..0000000000 --- a/containers/latex/.devcontainer/ignore +++ /dev/null @@ -1,5 +0,0 @@ -README.md -test-project -.vscode -!.vscode/devContainer.json -!.vscode/devcontainer.json diff --git a/containers/latex/.vscode/devContainer.json b/containers/latex/.vscode/devContainer.json deleted file mode 100644 index 1acc444661..0000000000 --- a/containers/latex/.vscode/devContainer.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "name": "LaTeX", - "image": "tianon/latex", - "extensions": [ - "James-Yu.latex-workshop" - ] -} \ No newline at end of file diff --git a/containers/latex/README.md b/containers/latex/README.md deleted file mode 100644 index c82006fba4..0000000000 --- a/containers/latex/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# LaTeX container - -To test, grab a sample .tex file from somewhere and place it in this folder. - -For example, you can find samples and templates [here](https://www.latextemplates.com) and [here](https://services.math.duke.edu/computing/tex/templates.html). \ No newline at end of file diff --git a/containers/markdown/README.md b/containers/markdown/README.md new file mode 100644 index 0000000000..76c1ce6950 --- /dev/null +++ b/containers/markdown/README.md @@ -0,0 +1,30 @@ +# Markdown + +## Summary + +*A basic dev container definition for editing markdown files in a container.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Markdown | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/php-7/README.md b/containers/php-7/README.md new file mode 100644 index 0000000000..70f918623e --- /dev/null +++ b/containers/php-7/README.md @@ -0,0 +1,30 @@ +# PHP v7 + +## Summary + +*A basic dev container definition for developing PHP applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | PHP | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/plantuml/README.md b/containers/plantuml/README.md index ae533fccae..9ef1d3fbd6 100644 --- a/containers/plantuml/README.md +++ b/containers/plantuml/README.md @@ -1,6 +1,27 @@ -# PlantUML Sample +# PlantUML -Sample container that includes Java and GraphViz and allows you to use the PlantUML extension. +## Summary + +*A basic dev container definition for editing PlantUML in a container that includes Java and GraphViz and the PlantUML extension.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | PlantUML | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. Check out the samples folder or just do a markdown preview on this file once you've opened this folder in the container! @@ -11,4 +32,10 @@ Brain -> Mouth: Say "Cool!" Mouth -> Ear: Cool! Ear -> Brain: Heard myself say Cool! @enduml -```` \ No newline at end of file +```` + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/powershell/README.md b/containers/powershell/README.md new file mode 100644 index 0000000000..9dd7edf720 --- /dev/null +++ b/containers/powershell/README.md @@ -0,0 +1,30 @@ +# PowerShell + +## Summary + +*A basic dev container definition for editing PowerShell scripts in a container.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | PowerShell | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. Run the script in `test-project` to check it out. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/python-2/README.md b/containers/python-2/README.md new file mode 100644 index 0000000000..d08632a57d --- /dev/null +++ b/containers/python-2/README.md @@ -0,0 +1,30 @@ +# Python v2 + +## Summary + +*A basic dev container definition for developing Python 2 applications in a container. Includes everything you need to get up and running like PyLint and the Python extension.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Python | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/python-3-django/README.md b/containers/python-3-django/README.md new file mode 100644 index 0000000000..67fa9fada9 --- /dev/null +++ b/containers/python-3-django/README.md @@ -0,0 +1,30 @@ +# Python v3 & Django + +## Summary + +*A basic dev container definition for building Django-based applications container. Includes everything you need to get up and running like Django, PyLint and the Python extension.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Python | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/python-3-flask-redis/README.md b/containers/python-3-flask-redis/README.md new file mode 100644 index 0000000000..503f573490 --- /dev/null +++ b/containers/python-3-flask-redis/README.md @@ -0,0 +1,30 @@ +# Python V3, Flask, & Redis + +## Summary + +*A basic multi-container dev container definition for building Flask applications in a container that rely on Redis. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Docker Compose | +| *Languages, platforms* | Python, Flask, Redis | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/python-3/README.md b/containers/python-3/README.md new file mode 100644 index 0000000000..d7dce90340 --- /dev/null +++ b/containers/python-3/README.md @@ -0,0 +1,30 @@ +# Python v3 + +## Summary + +*A basic dev container definition for developing Python 3 applications in a container. Includes everything you need to get up and running like PyLint and the Python extension.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Python | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/ruby-2/README.md b/containers/ruby-2/README.md new file mode 100644 index 0000000000..c5d802eec2 --- /dev/null +++ b/containers/ruby-2/README.md @@ -0,0 +1,30 @@ +# Ruby v2 + +## Summary + +*A basic dev container definition for developing Ruby applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Ruby | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/rust/README.md b/containers/rust/README.md new file mode 100644 index 0000000000..9a87780037 --- /dev/null +++ b/containers/rust/README.md @@ -0,0 +1,30 @@ +# Rust + +## Summary + +*A basic dev container definition for developing Rust applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Rust | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/swift-4/README.md b/containers/swift-4/README.md new file mode 100644 index 0000000000..8baa36a706 --- /dev/null +++ b/containers/swift-4/README.md @@ -0,0 +1,30 @@ +# Swift v4 + +## Summary + +*A basic dev container definition for developing Swift applications in a container. Includes everything you need to get up and running.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Swift | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE). diff --git a/containers/typescript-node-8/README.md b/containers/typescript-node-8/README.md new file mode 100644 index 0000000000..99c27948dd --- /dev/null +++ b/containers/typescript-node-8/README.md @@ -0,0 +1,30 @@ +# Node.js v8 & TypeScript + +## Summary + +*A basic dev container definition for building Node.js applications in TypeScript in a container. Includes everything you need to get up and running like Node.js and the TypeScript compiler.* + +| Metadata | Value | +|----------|-------| +| *Contributors* | The VS Code Team | +| *Definition type* | Dockerfile | +| *Languages, platforms* | Node.js, TypeScript | + +## Usage + +First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already. + +To use the definition with your own project: + +1. Copy the `.devcontainer` folder into your project root. +2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified. + +If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project. + +If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](../../LICENSE).