From b1985a7a19b7aa713eba6df87703c1e8db75e53f Mon Sep 17 00:00:00 2001 From: Chuck Lantz Date: Mon, 22 Apr 2019 10:25:02 -0700 Subject: [PATCH] Fix bad links --- containers/azure-cli/README.md | 33 ++++++++++++++++--- .../azure-functions-dotnetcore-2.1/README.md | 4 +-- .../README.md | 4 +-- containers/azure-functions-node-8/README.md | 4 +-- containers/azure-functions-node-lts/README.md | 4 +-- containers/azure-hdinsight-python-3/README.md | 4 +-- .../azure-machine-learning-python-3/README.md | 4 +-- containers/azure-terraform/README.md | 4 +-- .../docker-existing-docker-compose/README.md | 4 +-- .../docker-existing-dockerfile/README.md | 4 +-- containers/docker-in-docker-compose/README.md | 4 +-- containers/docker-in-docker/README.md | 4 +-- containers/kubernetes-helm/README.md | 2 +- containers/markdown/README.md | 4 +-- 14 files changed, 53 insertions(+), 30 deletions(-) diff --git a/containers/azure-cli/README.md b/containers/azure-cli/README.md index 49d064c5fe..f3443ed3d0 100644 --- a/containers/azure-cli/README.md +++ b/containers/azure-cli/README.md @@ -10,16 +10,39 @@ | *Definition type* | Dockerfile | | *Languages, platforms* | Any | -## Usage +## Using this definition with an existing folder -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +This definition does require any special steps to use. Just follow these steps: -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. +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. -If you want to try out the test project instead, open a cloned copy of this entire folder **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. +2. To use VS Code's copy of this definition: + 1. Start VS Code and open your project folder. + 2. Press F1 select and **Remote-Containers: Create Container Configuration File...** from the command palette. + 3. Select the Azure CLI definition. + +3. To use latest-and-greatest copy of this definition from the repository: + 1. Clone this repository. + 2. Copy the contents of `containers/azure-cli/.devcontainer` to the root of your project folder. + 3. Start VS Code and open your project folder. + +4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs. + +5. Finally, press F1 and run **Remote-Containers: Reopen Folder in Container** to start using the definition. + +## Testing the definition + +This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps: + +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. +2. Clone this repository. +3. Start VS Code, press F1, and select **Remote-Containers: Open Folder in Container...** +4. Select the `containers/azure-cli` folder. +5. After the folder has opened in the container, `open test-project/scripting.azcli` +6. ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). \ No newline at end of file diff --git a/containers/azure-functions-dotnetcore-2.1/README.md b/containers/azure-functions-dotnetcore-2.1/README.md index 49d5476045..7f2da313f9 100644 --- a/containers/azure-functions-dotnetcore-2.1/README.md +++ b/containers/azure-functions-dotnetcore-2.1/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/azure-functions-dotnetcore-latest/README.md b/containers/azure-functions-dotnetcore-latest/README.md index b4271f7c20..a09def5d34 100644 --- a/containers/azure-functions-dotnetcore-latest/README.md +++ b/containers/azure-functions-dotnetcore-latest/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/azure-functions-node-8/README.md b/containers/azure-functions-node-8/README.md index 09c361d410..5428be2ae8 100644 --- a/containers/azure-functions-node-8/README.md +++ b/containers/azure-functions-node-8/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/azure-functions-node-lts/README.md b/containers/azure-functions-node-lts/README.md index abc4c2a1e1..6f31f094ee 100644 --- a/containers/azure-functions-node-lts/README.md +++ b/containers/azure-functions-node-lts/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/azure-hdinsight-python-3/README.md b/containers/azure-hdinsight-python-3/README.md index 870c867a33..6c925ec5f4 100644 --- a/containers/azure-hdinsight-python-3/README.md +++ b/containers/azure-hdinsight-python-3/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/azure-machine-learning-python-3/README.md b/containers/azure-machine-learning-python-3/README.md index 0a0c12b2de..669f20c11f 100644 --- a/containers/azure-machine-learning-python-3/README.md +++ b/containers/azure-machine-learning-python-3/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/azure-terraform/README.md b/containers/azure-terraform/README.md index d734d5a0aa..d2e4855ce6 100644 --- a/containers/azure-terraform/README.md +++ b/containers/azure-terraform/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/docker-existing-docker-compose/README.md b/containers/docker-existing-docker-compose/README.md index 134bcd1ff9..3f788534c4 100644 --- a/containers/docker-existing-docker-compose/README.md +++ b/containers/docker-existing-docker-compose/README.md @@ -20,11 +20,11 @@ To use the definition with an existing project that contains a `docker-compose.y 2. Modify the `.devcontainer/dev-container.yml` and `devcontainer.json` files 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. -[See here for more information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for more information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/docker-existing-dockerfile/README.md b/containers/docker-existing-dockerfile/README.md index 8e0f45686a..82adbd3494 100644 --- a/containers/docker-existing-dockerfile/README.md +++ b/containers/docker-existing-dockerfile/README.md @@ -20,10 +20,10 @@ To use the definition with your own project that contains a `Dockerfile`: 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. -[See here for more information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for more information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/docker-in-docker-compose/README.md b/containers/docker-in-docker-compose/README.md index f83b98d15b..ce31d530a8 100644 --- a/containers/docker-in-docker-compose/README.md +++ b/containers/docker-in-docker-compose/README.md @@ -18,7 +18,7 @@ Dev containers can be useful for all types of applications including those that ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -55,4 +55,4 @@ That's it! Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/docker-in-docker/README.md b/containers/docker-in-docker/README.md index be255035b6..c4f8a44444 100644 --- a/containers/docker-in-docker/README.md +++ b/containers/docker-in-docker/README.md @@ -18,7 +18,7 @@ Dev containers can be useful for all types of applications including those that ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -58,4 +58,4 @@ That's it! Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/kubernetes-helm/README.md b/containers/kubernetes-helm/README.md index c4d1520ef8..ae4e91555b 100644 --- a/containers/kubernetes-helm/README.md +++ b/containers/kubernetes-helm/README.md @@ -108,4 +108,4 @@ That's it! Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). diff --git a/containers/markdown/README.md b/containers/markdown/README.md index 3329d144d7..a7167f9f70 100644 --- a/containers/markdown/README.md +++ b/containers/markdown/README.md @@ -12,7 +12,7 @@ ## Usage -[See here for information on using this definition with an existing project](../../README.md#using-a-definition). +[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open). 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. @@ -20,4 +20,4 @@ If you prefer, you can also just look through the contents of the `.devcontainer Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the MIT License. See [LICENSE](../../LICENSE). +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).