From 31b9f458aa29afbfaf1613c68f548f6d680694a5 Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 7 Aug 2023 16:41:23 +0000 Subject: [PATCH 1/5] fix: image formatting for gateway docs --- docs/ides/gateway.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index 3f2afbd9b55c3..89c793dd3e3f0 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -18,11 +18,10 @@ manually setting up an SSH connection. 1. Click the "Coder" icon under Install More Providers at the bottom of the Gateway home screen 1. Click "Connect to Coder" at the top of the Gateway home screen to launch the - plugin ![Gateway Connect to -Coder](../images/gateway/plugin-connect-to-coder.png) -1. Enter your Coder deployment's Access Url and click "Connect" then paste the - Session Token and click "OK" ![Gateway Session -Token](../images/gateway/plugin-session-token.png) + plugin + ![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png) +1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK" + ![Gateway Session Token](../images/gateway/plugin-session-token.png) 1. Click the "+" icon to open a browser and go to the templates page in your Coder deployment to create a workspace 1. If a workspace already exists but is stopped, click the green arrow to start @@ -30,9 +29,8 @@ Token](../images/gateway/plugin-session-token.png) 1. Once the workspace status says Running, click "Select IDE and Project" ![Gateway IDE List](../images/gateway/plugin-select-ide.png) 1. Select the JetBrains IDE for your project and the project directory then - click "Start IDE and connect" ![Gateway Select -IDE](../images/gateway/plugin-ide-list.png) ![Gateway IDE -Opened](../images/gateway/gateway-intellij-opened.png) + click "Start IDE and connect" ![Gateway Select IDE](../images/gateway/plugin-ide-list.png) + ![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png) > Note the JetBrains IDE is remotely installed into > `~/.cache/JetBrains/RemoteDev/dist` @@ -42,8 +40,7 @@ Opened](../images/gateway/gateway-intellij-opened.png) 1. Click the gear icon at the bottom left of the Gateway home screen and then "Settings" 1. In the Marketplace tab within Plugins, type Coder and if a newer plugin - release is available, click "Update" and "OK" ![Gateway Settings and -Marketplace](../images/gateway/plugin-settings-marketplace.png) + release is available, click "Update" and "OK" ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png) ### Configuring the Gateway plugin to use internal certificates @@ -116,17 +113,17 @@ Connection](../images/gateway/gateway-add-ssh-configuration.png) 1. Click "Test Connection" to validate these settings. 1. Click "OK" ![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png) -1. Select the connection you just added ![Gateway -Welcome](../images/gateway/gateway-welcome.png) -1. Click "Check Connection and Continue" ![Gateway -Continue](../images/gateway/gateway-continue.png) +1. Select the connection you just added + ![Gateway Welcome](../images/gateway/gateway-welcome.png) +1. Click "Check Connection and Continue" + ![Gateway Continue](../images/gateway/gateway-continue.png) 1. Select the JetBrains IDE for your project and the project directory. SSH into your server to create a directory or check out code if you haven't already. ![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png) > Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist` -1. Click "Download and Start IDE" to connect. ![Gateway IDE -Opened](../images/gateway/gateway-intellij-opened.png) +1. Click "Download and Start IDE" to connect. + ![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png) ## Using an existing JetBrains installation in the workspace From 77ed4aa15d3d46000a0cf8eaca2372a8316aee07 Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 7 Aug 2023 17:22:37 +0000 Subject: [PATCH 2/5] chore: fix some more spots --- docs/ides/gateway.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index 89c793dd3e3f0..0719e4c7b5240 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -99,11 +99,12 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ 1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html) 1. [Configure the `coder` CLI](../ides.md#ssh-configuration) 1. Open Gateway, make sure "SSH" is selected under "Remote Development" -1. Click "New Connection" ![Gateway Home](../images/gateway/gateway-home.png) +1. Click "New Connection" + ![Gateway Home](../images/gateway/gateway-home.png) 1. In the resulting dialog, click the gear icon to the right of "Connection:" ![Gateway New Connection](../images/gateway/gateway-new-connection.png) -1. Hit the "+" button to add a new SSH connection ![Gateway Add -Connection](../images/gateway/gateway-add-ssh-configuration.png) +1. Hit the "+" button to add a new SSH connection + ![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png) 1. For the Host, enter `coder.` 1. For the Port, enter `22` (this is ignored by Coder) @@ -111,10 +112,10 @@ Connection](../images/gateway/gateway-add-ssh-configuration.png) 1. For the Authentication Type, select "OpenSSH config and authentication agent" 1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked. 1. Click "Test Connection" to validate these settings. -1. Click "OK" ![Gateway SSH -Configuration](../images/gateway/gateway-create-ssh-configuration.png) +1. Click "OK" + ![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png) 1. Select the connection you just added - ![Gateway Welcome](../images/gateway/gateway-welcome.png) + ![Gateway Welcome](../images/gaGteway/gateway-welcome.png) 1. Click "Check Connection and Continue" ![Gateway Continue](../images/gateway/gateway-continue.png) 1. Select the JetBrains IDE for your project and the project directory. SSH into From cea47f2d9831a9d3c995009ae2a2b4658a06efda Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 7 Aug 2023 17:23:40 +0000 Subject: [PATCH 3/5] more --- docs/ides/gateway.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index 0719e4c7b5240..7bf1fe1976980 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -40,7 +40,8 @@ manually setting up an SSH connection. 1. Click the gear icon at the bottom left of the Gateway home screen and then "Settings" 1. In the Marketplace tab within Plugins, type Coder and if a newer plugin - release is available, click "Update" and "OK" ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png) + release is available, click "Update" and "OK" + ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png) ### Configuring the Gateway plugin to use internal certificates From 2f23e631c4bbac60d0d98b1b79c2df6ebfa2d975 Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 7 Aug 2023 17:25:07 +0000 Subject: [PATCH 4/5] fmt --- docs/ides/gateway.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index 6aca1f270b417..109a2b859b3d7 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -101,7 +101,7 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ 1. [Configure the `coder` CLI](../ides.md#ssh-configuration) 1. Open Gateway, make sure "SSH" is selected under "Remote Development" 1. Click "New Connection" - ![Gateway Home](../images/gateway/gateway-home.png) + ![Gateway Home](../images/gateway/gateway-home.png) 1. In the resulting dialog, click the gear icon to the right of "Connection:" ![Gateway New Connection](../images/gateway/gateway-new-connection.png) 1. Hit the "+" button to add a new SSH connection From 2ea6fded8eec8b4fcc954ba50ef261ec490bcf7e Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 7 Aug 2023 17:31:39 +0000 Subject: [PATCH 5/5] space things out more --- docs/ides/gateway.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index 109a2b859b3d7..b0550c378b668 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -19,17 +19,26 @@ manually setting up an SSH connection. Gateway home screen 1. Click "Connect to Coder" at the top of the Gateway home screen to launch the plugin + ![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png) + 1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK" + ![Gateway Session Token](../images/gateway/plugin-session-token.png) + 1. Click the "+" icon to open a browser and go to the templates page in your Coder deployment to create a workspace + 1. If a workspace already exists but is stopped, click the green arrow to start the workspace + 1. Once the workspace status says Running, click "Select IDE and Project" + ![Gateway IDE List](../images/gateway/plugin-select-ide.png) + 1. Select the JetBrains IDE for your project and the project directory then click "Start IDE and connect" ![Gateway Select IDE](../images/gateway/plugin-ide-list.png) + ![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png) > Note the JetBrains IDE is remotely installed into @@ -39,8 +48,10 @@ manually setting up an SSH connection. 1. Click the gear icon at the bottom left of the Gateway home screen and then "Settings" + 1. In the Marketplace tab within Plugins, type Coder and if a newer plugin release is available, click "Update" and "OK" + ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png) ### Configuring the Gateway plugin to use internal certificates @@ -98,33 +109,56 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ > these steps. 1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html) + 1. [Configure the `coder` CLI](../ides.md#ssh-configuration) + 1. Open Gateway, make sure "SSH" is selected under "Remote Development" + 1. Click "New Connection" + ![Gateway Home](../images/gateway/gateway-home.png) + 1. In the resulting dialog, click the gear icon to the right of "Connection:" + ![Gateway New Connection](../images/gateway/gateway-new-connection.png) + 1. Hit the "+" button to add a new SSH connection + ![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png) 1. For the Host, enter `coder.` + 1. For the Port, enter `22` (this is ignored by Coder) + 1. For the Username, enter your workspace username + 1. For the Authentication Type, select "OpenSSH config and authentication agent" + 1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked. + 1. Click "Test Connection" to validate these settings. + 1. Click "OK" + ![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png) + 1. Select the connection you just added + ![Gateway Welcome](../images/gaGteway/gateway-welcome.png) + 1. Click "Check Connection and Continue" + ![Gateway Continue](../images/gateway/gateway-continue.png) -1. Select the JetBrains IDE for your project and the project directory. SSH into - your server to create a directory or check out code if you haven't already. + +1. Select the JetBrains IDE for your project and the project directory. SSH into your server to create a directory or check out code if you haven't already. + ![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png) + > Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist` + 1. Click "Download and Start IDE" to connect. + ![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png) ## Using an existing JetBrains installation in the workspace