Skip to content

Commit 3b16e71

Browse files
authored
fix: improve formatting in Gateway docs (#8949)
* fix: image formatting for gateway docs * chore: fix some more spots * more * fmt * space things out more
1 parent b67ece1 commit 3b16e71

File tree

1 file changed

+45
-9
lines changed

1 file changed

+45
-9
lines changed

docs/ides/gateway.md

+45-9
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,26 @@ manually setting up an SSH connection.
1919
Gateway home screen
2020
1. Click "Connect to Coder" at the top of the Gateway home screen to launch the
2121
plugin
22+
2223
![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png)
24+
2325
1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK"
26+
2427
![Gateway Session Token](../images/gateway/plugin-session-token.png)
28+
2529
1. Click the "+" icon to open a browser and go to the templates page in your
2630
Coder deployment to create a workspace
31+
2732
1. If a workspace already exists but is stopped, click the green arrow to start
2833
the workspace
34+
2935
1. Once the workspace status says Running, click "Select IDE and Project"
36+
3037
![Gateway IDE List](../images/gateway/plugin-select-ide.png)
38+
3139
1. Select the JetBrains IDE for your project and the project directory then
3240
click "Start IDE and connect" ![Gateway Select IDE](../images/gateway/plugin-ide-list.png)
41+
3342
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
3443

3544
> Note the JetBrains IDE is remotely installed into
@@ -39,8 +48,11 @@ manually setting up an SSH connection.
3948

4049
1. Click the gear icon at the bottom left of the Gateway home screen and then
4150
"Settings"
51+
4252
1. In the Marketplace tab within Plugins, type Coder and if a newer plugin
43-
release is available, click "Update" and "OK" ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)
53+
release is available, click "Update" and "OK"
54+
55+
![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)
4456

4557
### Configuring the Gateway plugin to use internal certificates
4658

@@ -97,32 +109,56 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\
97109
> these steps.
98110
99111
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
112+
100113
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
114+
101115
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
102-
1. Click "New Connection" ![Gateway Home](../images/gateway/gateway-home.png)
116+
117+
1. Click "New Connection"
118+
119+
![Gateway Home](../images/gateway/gateway-home.png)
120+
103121
1. In the resulting dialog, click the gear icon to the right of "Connection:"
122+
104123
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
105-
1. Hit the "+" button to add a new SSH connection ![Gateway Add
106-
Connection](../images/gateway/gateway-add-ssh-configuration.png)
124+
125+
1. Hit the "+" button to add a new SSH connection
126+
127+
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
107128

108129
1. For the Host, enter `coder.<workspace name>`
130+
109131
1. For the Port, enter `22` (this is ignored by Coder)
132+
110133
1. For the Username, enter your workspace username
134+
111135
1. For the Authentication Type, select "OpenSSH config and authentication agent"
136+
112137
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
138+
113139
1. Click "Test Connection" to validate these settings.
114-
1. Click "OK" ![Gateway SSH
115-
Configuration](../images/gateway/gateway-create-ssh-configuration.png)
140+
141+
1. Click "OK"
142+
143+
![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)
144+
116145
1. Select the connection you just added
117-
![Gateway Welcome](../images/gateway/gateway-welcome.png)
146+
147+
![Gateway Welcome](../images/gaGteway/gateway-welcome.png)
148+
118149
1. Click "Check Connection and Continue"
150+
119151
![Gateway Continue](../images/gateway/gateway-continue.png)
120-
1. Select the JetBrains IDE for your project and the project directory. SSH into
121-
your server to create a directory or check out code if you haven't already.
152+
153+
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.
154+
122155
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
156+
123157
> Note the JetBrains IDE is remotely installed into `~/.
124158
cache/JetBrains/RemoteDev/dist`
159+
125160
1. Click "Download and Start IDE" to connect.
161+
126162
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
127163

128164
## Using an existing JetBrains installation in the workspace

0 commit comments

Comments
 (0)