Skip to content

Commit

Permalink
docs(sage-monorepo): update developer docs on how to connect to the E…
Browse files Browse the repository at this point in the history
…C2 instance from VS Code (#2677)

undefined
  • Loading branch information
hallieswan authored May 14, 2024
1 parent 1a63713 commit 36feccc
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/developers-guide/developing-on-a-remote-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ $ speedtest
## Preparing the remote host - AWS EC2

This section describes how to instantiate an AWS EC2 as the remote host. Steps outlined below will
assume you have access to the Sage AWS Service Catalog.
assume you have access to the [Sage AWS Service Catalog](https://help.sc.sageit.org/sc/Service-Catalog-Provisioning.938836322.html).

### Creating the EC2 instance

Expand Down Expand Up @@ -198,7 +198,7 @@ key.

### Configuring SSH on the local machine

This section describes how to create a profile for the EC2 instance in your local `~./ssh/config`
This section describes how to create a profile for the EC2 instance in your local `~/.ssh/config`
file.

!!! note
Expand Down Expand Up @@ -230,11 +230,12 @@ Then, on your local machine:

### Connecting to the EC2 instance with VS Code

1. Open VS Code.
2. Install the VS Code extension pack "Remote Development".
3. Open the command palette with `Ctrl+Shit+P`.
4. `Remote-SSH: Connect to Host...` > Select the host.
5. Answer the prompts
1. Connect to the [Sage VPN](https://sagebionetworks.jira.com/wiki/spaces/IT/pages/1705246745/AWS+Client+VPN+User+Guide).
2. Open VS Code.
3. Install the VS Code extension pack "Remote Development".
4. Open the command palette with `Ctrl+Shit+P`.
5. `Remote-SSH: Connect to Host...` > Select the host.
6. Answer the prompts

You are now connected to the EC2 instance! 🚀

Expand Down

0 comments on commit 36feccc

Please sign in to comment.