From da8ede66745bc1907df7bac374a07700daec7e92 Mon Sep 17 00:00:00 2001 From: Brigit Murtaugh Date: Tue, 8 Dec 2020 12:15:58 -0800 Subject: [PATCH] Update formatting --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 247d7c2..64dc35a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A **development container** is a running [Docker](https://www.docker.com) contai The [VS Code Remote - Containers](https://aka.ms/vscode-remote/download/containers) extension allows you to clone a repository or open any folder mounted into (or already inside) a dev container and take advantage of VS Code's full development feature set. -This is a sample project that lets you try out either option in a few easy steps. +This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too. > **Note:** If you already have a Codespace or dev container, you can jump to the [Things to try](#things-to-try) section. @@ -27,7 +27,7 @@ Follow these steps to open this sample in a container using the VS Code Remote - - Press F1 and select the **Remote-Containers: Try a Sample...** command. - Choose the "Node" sample, wait for the container to start, and try things out! - > **Note:** Under the hood, this will use the **Remote-Containers: Clone Repository in Container Volume...** command to clone the source code in a Docker volume instead of the local filesystem. [Volumes](https://docs.docker.com/storage/volumes/) are the preferred mechanism for persisting data generated by and used by Docker containers. + > **Note:** Under the hood, this will use the **Remote-Containers: Clone Repository in Container Volume...** command to clone the source code in a Docker volume instead of the local filesystem. [Volumes](https://docs.docker.com/storage/volumes/) are the preferred mechanism for persisting container data. Or open a locally cloned copy of the code: @@ -55,9 +55,13 @@ Some things to try: - Once the breakpoint is hit, try hovering over variables, examining locals, and more. - Continue and from the notification that is shown open a browser. Note you can connect to the server in the container. - The status line shows '1 Port Available'. Clicking the status bar entry shows the 'Ports' view that lists the currently available ports. -4. **Rebuild or update your container** - - You may want to make changes to your container, such as installing a different version of a software or forwarding a new port. You'll rebuild your container for your changes to take effect. *Note: Currently, only containers with the VS Code Remote - Containers extension can be rebuilt.* -**Forward a port statically:** As an example change, let's forward a port statically in the `.devcontainer/devcontainer.json` file. *Note: Remote-Containers and Codespaces also take care of dynamic port forwarding, but there may be instances in which we want to statically declare a forwarded port.* +4. **Rebuild or update your container** (*Currently, only containers with the VS Code Remote - Containers extension can be rebuilt.*) + - You may want to make changes to your container, such as installing a different version of a software or forwarding a new port. You'll rebuild your container for your changes to take effect. + +- **Forward a port statically:** As an example change, let's forward a port statically in the `.devcontainer/devcontainer.json` file. + + > **Note:** Remote-Containers and Codespaces also take care of dynamic port forwarding, but there may be instances in which we want to statically declare a forwarded port. + - Open the `.devcontainer/devcontainer.json` file. - Uncomment the `forwardedPorts` attribute and adjust the port number as needed. - Press F1 and select the **Remote-Containers: Rebuild Container** command so the modifications are picked up.