From e0f8a84e60d8bc1d3566327da7270d1bd6fbfb6c Mon Sep 17 00:00:00 2001 From: Usha Mandya Date: Tue, 29 Jun 2021 10:08:42 +0100 Subject: [PATCH] Note on adding SSH key to the ssh-agent Signed-off-by: Usha Mandya --- desktop/dev-environments.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/desktop/dev-environments.md b/desktop/dev-environments.md index 6eeeaac734..f96e093a5c 100644 --- a/desktop/dev-environments.md +++ b/desktop/dev-environments.md @@ -35,10 +35,14 @@ Click **Install** to download and install any missing tools. ## Start a single container Dev Environment -The simplest way to get started with Dev Environments is to create a new environment by cloning the Git repository of the project you are working on. For example, let us create a new Dev Environment using a simple `singe-dev-env` project from the [Docker Samples](https://github.com/dockersamples/single-dev-env){:target="_blank" rel="noopener" class="_"} GitHub repository. +The simplest way to get started with Dev Environments is to create a new environment by cloning the Git repository of the project you are working on. For example, let us create a new Dev Environment using a simple `single-dev-env` project from the [Docker Samples](https://github.com/dockersamples/single-dev-env){:target="_blank" rel="noopener" class="_"} GitHub repository. + +> **Note** +> +> When cloning a Git repository using SSH, ensure you've added your SSH key to the ssh-agent. To do this, open a terminal and run `ssh-add `. 1. First, let's copy `git@github.com:dockersamples/single-dev-env.git` and add it to the **Create** field on the **Create a Development Environment** page. -3. Now, click **Create**. +2. Now, click **Create**. This clones the Git code inside a volume, determines the best image for your Dev Environment, and finally, opens VS Code inside the Dev Environment container. @@ -78,6 +82,10 @@ Using this shared Dev Environment, your team members can access the code, any de You can also use Dev Environments to collaborate on any Docker Compose-based projects. For example, let's use the `compose-dev-env` project from the [Docker Samples](https://github.com/dockersamples/compose-dev-env){:target="_blank" rel="noopener" class="_"} GitHub repository. + > **Note** + > + > When cloning a Git repository using SSH, ensure you've added your SSH key to the ssh-agent. To do this, open a terminal and run `ssh-add `. + 1. Copy `git@github.com:dockersamples/compose-dev-env.git` and add it to the **Create** field on the **Create a Development Environment** page. 2. Click **Create**. This initializes the project and clones the Git code and builds the Compose application. This: