diff --git a/docs/containers/app-service.md b/docs/containers/app-service.md index 8d8b7a232..255e7a88c 100644 --- a/docs/containers/app-service.md +++ b/docs/containers/app-service.md @@ -4,7 +4,7 @@ Area: containers TOCTitle: Deploy to Azure ContentId: 044913F5-F99D-4228-A916-0443260AB7FB PageTitle: Deploy a containerized app to Azure App Service -DateApproved: +DateApproved: MetaDescription: Using Visual Studio Code, build a container image for your application, push the image to a container registry, and deploy to Azure App Service. --- # Deploy a containerized app to Azure App Service @@ -52,7 +52,7 @@ Before deploying the image to an App Service, the image must be uploaded to a co - The image built in previous section will appear in the Docker view under Images section. Right-click and choose **Tag...**. ![Tag image](images/app-service/explorer-tag-image.png) - - Specify the new name `/:` and complete the + - Specify the new name `/:` and complete the tag action. For example, new image name for ACR would be 'mainacr.azurecr.io/webapp6:latest' and for Docker Hub it would be 'myusername/webapp6:latest'. 4. The newly tagged image will show up in the Docker view under the registry that the image tag points to. Select this image and choose "Push". @@ -84,7 +84,7 @@ In the previous section, the image is pushed to a remote container registry. Now ![Deployment complete output](images/app-service/output-appservice-deployment.png) -5. To browse the deployed website, you can use Ctrl+Click to open the URL in the Output panel. The new App Service also appears in the Azure view in Visual Studio Code under the App Service section, where you can right-click the website and select Browse Website. +5. To browse the deployed website, you can use `kbstyle(Ctrl+click)` to open the URL in the Output panel. The new App Service also appears in the Azure view in Visual Studio Code under the App Service section, where you can right-click the website and select Browse Website. ![Web Application](images/app-service/webapp-homepage.png) diff --git a/docs/containers/choosing-dev-environment.md b/docs/containers/choosing-dev-environment.md index 2159a4b86..a657b3768 100644 --- a/docs/containers/choosing-dev-environment.md +++ b/docs/containers/choosing-dev-environment.md @@ -11,17 +11,17 @@ MetaDescription: Guidance on choosing remote or local environments for developin You can choose whether to develop a container-based service in the **local environment**, or in a **remote environment**. The local environment is the operating system of your developer workstation; using the local environment means you build and run your service container(s) using Docker installed on your workstation. -[A remote development environment](https://code.visualstudio.com/docs/remote/remote-overview) is different from your developer workstation. It can be a remote machine accessible via SSH, a virtual machine running on your developer workstation, or a development container. A remote environment can have advantages over the local environment, the main one being **the ability to use the same operating system during development, and when your service is running in production**. To use a remote environment, you need to ensure that `docker` command (Docker CLI) [is available and functional within that environment](#enabling-docker-cli-inside-a-development-environment). +[A remote development environment](/docs/remote/remote-overview.md) is different from your developer workstation. It can be a remote machine accessible via SSH, a virtual machine running on your developer workstation, or a development container. A remote environment can have advantages over the local environment, the main one being **the ability to use the same operating system during development, and when your service is running in production**. To use a remote environment, you need to ensure that `docker` command (Docker CLI) [is available and functional within that environment](#enabling-docker-cli-inside-a-development-environment). The second important choice is whether to debug your service running as a ordinary process, or **debug your service running in a container**. ## Guidelines for choosing a development environment 1. Use the local environment when you are not particularly concerned about: - - using the same OS for development and inside the service container, nor + - using the same OS for development and inside the service container, nor - installing necessary tools and dependencies on top of your local environment. -1. Consider [development container](https://code.visualstudio.com/docs/remote/containers) first if you need a remote environment. +1. Consider [development container](/docs/remote/containers.md) first if you need a remote environment. - On Windows, [Windows Subsystem for Linux (WSL)](#windows-subsystem-for-linux) is worth considering as an alternative. 1. Debugging your service running in a container is possible, but brings additional complexity. Use normal debugging by default, and debugging in container when you need it. diff --git a/docs/containers/debug-common.md b/docs/containers/debug-common.md index 46c7b46a2..36a7cf9b7 100644 --- a/docs/containers/debug-common.md +++ b/docs/containers/debug-common.md @@ -4,7 +4,7 @@ Area: containers TOCTitle: Debug ContentId: A1371726-5310-4923-B43B-240F36C6264E PageTitle: Debug an app running in a Docker container -DateApproved: +DateApproved: MetaDescription: Debug an app running in a Docker container, using Visual Studio Code. --- # Debug apps within Docker containers @@ -94,7 +94,7 @@ More information about debugging Node.js applications within Docker containers c ### `node` Object Properties -> These properties are the same as those described in the [VS Code documentation](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_launch-configuration-attributes) for attaching a debugger to Node.js applications. All properties passed in the `node` object will be passed on to the Node.js debug adaptor, even if not specifically listed below. +> These properties are the same as those described in the [VS Code documentation](/docs/nodejs/nodejs-debugging.md#launch-configuration-attributes) for attaching a debugger to Node.js applications. All properties passed in the `node` object will be passed on to the Node.js debug adaptor, even if not specifically listed below. | Property | Description | Default | | --- | --- | --- | diff --git a/docs/containers/overview.md b/docs/containers/overview.md index be7906fdb..535c9043f 100644 --- a/docs/containers/overview.md +++ b/docs/containers/overview.md @@ -4,12 +4,12 @@ Area: containers TOCTitle: Overview ContentId: 4B462667-8915-4BE0-B8D0-EDE51CB2D273 PageTitle: Container tools extension for Visual Studio Code -DateApproved: +DateApproved: MetaDescription: Tools for developing and debugging with Docker containers, using Visual Studio Code. --- # Container Tools extension -The Docker extension makes it easy to build, manage and deploy containerized applications from Visual Studio Code. +The Docker extension makes it easy to build, manage and deploy containerized applications from Visual Studio Code. This page provides an overview of the Docker extension capabilities; use the side menu to learn more about topics of interest. If you are just getting started with Docker development, read about [Docker application development](https://docs.docker.com/develop/) first to understand key Docker concepts. @@ -33,7 +33,7 @@ In addition, you can use the Problems panel to view common errors for `Dockerfil ## Generating Docker files -You can add Docker files to your workspace by opening the Command Palette (`kb(workbench.action.showCommands)` key) and using `Docker: Add Docker Files to Workspace` command. The command will generate `Dockerfile` and `.dockerignore` files and add them to your workspace. The command will also query you if you want the Docker Compose files added as well; this is optional. +You can add Docker files to your workspace by opening the Command Palette (`kb(workbench.action.showCommands)` key) and using **Docker: Add Docker Files to Workspace** command. The command will generate `Dockerfile` and `.dockerignore` files and add them to your workspace. The command will also query you if you want the Docker Compose files added as well; this is optional. The extension recognizes workspaces that use most popular development languages (C#, Node.js, Python, Ruby, Go and Java) and customizes generated Docker files accordingly. @@ -55,7 +55,7 @@ Many of the most common Docker commands are built right into the Command Palette ![Docker commands](images/overview/command-palette.png) -You can run Docker commands to manage [images](https://docs.docker.com/engine/reference/commandline/image/), [networks](https://docs.docker.com/engine/reference/commandline/network/), [volumes](https://docs.docker.com/engine/reference/commandline/volume/), [image registries](https://docs.docker.com/engine/reference/commandline/push/) and [Docker Compose](https://docs.docker.com/compose/reference/overview/). In addition, the `Docker: Prune System` command will remove stopped containers, dangling images, and unused networks and volumes. +You can run Docker commands to manage [images](https://docs.docker.com/engine/reference/commandline/image/), [networks](https://docs.docker.com/engine/reference/commandline/network/), [volumes](https://docs.docker.com/engine/reference/commandline/volume/), [image registries](https://docs.docker.com/engine/reference/commandline/push/) and [Docker Compose](https://docs.docker.com/compose/reference/overview/). In addition, the **Docker: Prune System** command will remove stopped containers, dangling images, and unused networks and volumes. ## Using image registries @@ -83,15 +83,15 @@ Visual Studio Code's experience for authoring `docker-compose.yml` is also very 2. Define a new service called `web:` 3. On the second line, bring up IntelliSense by pressing `kb(editor.action.triggerSuggest)` to see a list of all valid compose directives. - ![Docker Compose IntelliSense](images/docker/dockercomposeintellisense.png) + ![Docker Compose IntelliSense](images/overview/dockercomposeintellisense.png) 4. For the `image` directive, you can press `kb(editor.action.triggerSuggest)` again and VS Code will query the Docker Hub index for public images. - ![Docker Compose image suggestions](images/docker/dockercomposeimageintellisense.png) + ![Docker Compose image suggestions](images/overview/dockercomposeimageintellisense.png) VS Code will first show a list of popular images along with metadata such as the number of stars and description. If you continue typing, VS Code will query the Docker Hub index for matching images, including searching public profiles. For example, searching for `Microsoft` will show you all the public Microsoft images. - ![Docker Compose Microsoft image suggestions](images/docker/dockercomposesearch.png) + ![Docker Compose Microsoft image suggestions](images/overview/dockercomposesearch.png) ## Next steps diff --git a/docs/containers/quickstart-aspnet-core.md b/docs/containers/quickstart-aspnet-core.md index eaf1f5182..6cdf3dd14 100644 --- a/docs/containers/quickstart-aspnet-core.md +++ b/docs/containers/quickstart-aspnet-core.md @@ -4,7 +4,7 @@ Area: containers TOCTitle: ASP.NET Core ContentId: 29F731D4-C6FE-4742-A1E7-7288FDB81CB9 PageTitle: Build and run an ASP.NET Core app in a container -DateApproved: +DateApproved: MetaDescription: Develop, build, and debug an ASP.NET Core app in a Docker container, using Visual Studio Code. --- # Build and run an ASP.NET Core app in a container @@ -18,7 +18,7 @@ In this guide you will learn how to: ## Prerequisites - Docker and the VS Code Docker extension must be installed as described on the [[Home page|Home#installation]]. -- For .NET development install [.NET Core SDK](https://dotnet.microsoft.com/download). +- For .NET development install [.NET Core SDK](https://dotnet.microsoft.com/download). - [C# VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp). ## Create a .NET Core Web API project @@ -33,7 +33,7 @@ In this guide you will learn how to: ## Add Docker files to the project 1. Open the project folder in VS Code -1. Open Command Palette (`kb(workbench.action.showCommands)`) and use `Docker: Add Docker Files to Workspace...` command: +1. Open Command Palette (`kb(workbench.action.showCommands)`) and use **Docker: Add Docker Files to Workspace...** command: ![Add Dockerfile to a .NET project](images/quickstarts/aspnetcore-add-dotnet.png) @@ -41,7 +41,7 @@ In this guide you will learn how to: 1. Choose `Windows` or `Linux` when prompted to choose the operating system. > `Windows` is only applicable if your Docker installation is configured to use Windows containers. 1. Change the port for application endpoint to `5000`. -1. `Dockerfile` and `.dockerignore` files are added to the workspace. +1. `Dockerfile` and `.dockerignore` files are added to the workspace. The extension will also create a set of **VS Code tasks** for building and running the container (in both debug- and release configuration, four tasks in total), and a **debugging configuration** for launching the container in debug mode. diff --git a/docs/containers/quickstart-node.md b/docs/containers/quickstart-node.md index d7b408099..3bf6f9e16 100644 --- a/docs/containers/quickstart-node.md +++ b/docs/containers/quickstart-node.md @@ -33,7 +33,7 @@ In this guide you will learn how to: ## Add Docker file to the project 1. Open the project folder in VS Code. -1. Open the Command Palette (`kb(workbench.action.showCommands)`) and use `Docker: Add Docker Files to Workspace...` command: +1. Open the Command Palette (`kb(workbench.action.showCommands)`) and use **Docker: Add Docker Files to Workspace...** command: ![Add Dockerfile to a Node.js project](images/quickstarts/node-add-node.png) @@ -60,7 +60,7 @@ The extension will create `Dockerfile` and `.dockerignore` files. If you elected ![Application page in browser](images/quickstarts/node-run-browser.png) -1. When done testing, type `Ctrl+C` in the terminal. +1. When done testing, type `kbstyle(Ctrl+C)` in the terminal. ## Build the service image