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

Commit 401821e

Browse files
committed
README cleanup
1 parent cbabb3d commit 401821e

File tree

10 files changed

+28
-23
lines changed

10 files changed

+28
-23
lines changed

containers/azure-cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition does require any special steps to use. Just follow these steps:
15+
This definition requires an Azure subscription to use. You can create a [free account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
1616

1717
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

containers/azure-functions-dotnetcore-2.1/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
15+
This definition requires an Azure subscription to use. You can create a [free account here](https://azure.microsoft.com/en-us/free/serverless/) and learn more about using [Azure Functions with VS Code here](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-vs-code). Once you have an Azure account, follow these steps:
16+
1617

1718
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1819

containers/azure-functions-dotnetcore-latest/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
15+
This definition requires an Azure subscription to use. You can create a [free account here](https://azure.microsoft.com/en-us/free/serverless/) and learn more about using [Azure Functions with VS Code here](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-vs-code). Once you have an Azure account, follow these steps:
1616

1717
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

containers/azure-functions-node-8/README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,25 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Azure Functions, Node.js, JavaScript |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
15+
This definition requires an Azure subscription to use. You can create a [free account here](https://azure.microsoft.com/en-us/free/serverless/) and learn more about using [Azure Functions with VS Code here](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-vs-code). Once you have an Azure account, follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
18+
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Azure Functions & Node.js 8 definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/azure-functions-node-8/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
1832

1933
## License
2034

containers/azure-functions-node-lts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
15+
This definition requires an Azure subscription to use. You can create a [free account here](https://azure.microsoft.com/en-us/free/serverless/) and learn more about using [Azure Functions with VS Code here](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-vs-code). Once you have an Azure account, follow these steps:
1616

1717
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

containers/azure-hdinsight-python-3/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
15+
This definition requires an Azure subscription to use. You can create a [free trial account here](https://azure.microsoft.com/en-us/free/) and learn more about using [Azure HDInsight with VS Code here](https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-for-vscode#open-hdinsight-work-folder). Once you have an Azure account, follow these steps:
1616

1717
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

containers/azure-machine-learning-python-3/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
15+
This definition requires an Azure subscription to use. You can create a [free account here](https://account.azure.com/signup?offer=ms-azr-0044p&appId=102&ref=azureplat-generic&redirectURL=https%3a%2f%2fazure.microsoft.com%2fen-us%2fget-started%2fwelcome-to-azure%2f&l=en-us&correlationId=15FE63BE1C4960F42D1B6EFB18496296) and learn more about using [Azure Machine Learning with VS Code here](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-vscode-tools#get-started-with-azure-machine-learning). Once you have an Azure account, follow these steps:
1616

1717
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1818

containers/azure-terraform/.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ RUN echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $(lsb
4444
&& apt-get update \
4545
&& apt-get install -y azure-cli
4646

47-
# Install Terraform and tflint
47+
# Install Terraform, tflint, and graphviz
4848
RUN mkdir -p /tmp/docker-downloads \
4949
&& curl -sSL -o /tmp/docker-downloads/terraform.zip https://releases.hashicorp.com/terraform/0.11.13/terraform_0.11.13_linux_amd64.zip \
5050
&& unzip /tmp/docker-downloads/terraform.zip \

containers/azure-terraform/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212

1313
## Using this definition with an existing folder
1414

15-
This definition requires an Azure subscription to use. Create a [free trial account here](https://azure.microsoft.com/en-us/free/). Once you have an Azure account, follow these steps:
15+
While technically optional, this definition includes the Azure Terraform extension which requires an Azure account to use. You can create a [free trial account here](https://azure.microsoft.com/en-us/free/) and find out more about using [Teraform with Azure here](https://docs.microsoft.com/en-us/azure/terraform/terraform-overview). If you plan to use the Azure Cloud Shell for all of your Terraform operations, you can comment out the installation of the Docker CLI in `.devcontainer/Dockerfile`. Conversely, if you do not plan to use Cloud Shell, you can comment out the installation of Node.js. The definition has been setup so you can do either as it makes sense.
16+
17+
Next, follow these steps:
1618

1719
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
1820

containers/typescript-node-lts/README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,6 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Node.js, TypeScript |
1212

13-
# Node.js 8 & TypeScript
14-
15-
## Summary
16-
17-
*Develop Node.js 8 based applications in TypeScript. Includes Node.js, tslint, yarn, and the TypeScript compiler.*
18-
19-
| Metadata | Value |
20-
|----------|-------|
21-
| *Contributors* | The VS Code Team |
22-
| *Definition type* | Dockerfile |
23-
| *Languages, platforms* | Node.js, TypeScript |
24-
2513
## Using this definition with an existing folder
2614

2715
This definition does require any special steps to use. Just follow these steps:

0 commit comments

Comments
 (0)