Skip to content

docs: clean up English #3324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 31, 2022
Merged

docs: clean up English #3324

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9755f5a
docs: clean up English
ammario Jul 31, 2022
8fea7d5
Fix issues in #3320
ammario Jul 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Fix issues in #3320
  • Loading branch information
@ammario
ammario committed Jul 31, 2022
commit 8fea7d54f5a46b16b3cc895f7c1b62bba6a8091b
2 changes: 0 additions & 2 deletions docs/ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ The following desktop IDEs have been tested with Coder, though any IDE with SSH
support should work:

- [VS Code Remote SSH](#vs-code-remote)
extension)
- [JetBrains with Gateway](./ides/configuring-gateway.md)
installed)
- IntelliJ IDEA
- CLion
- GoLand
Expand Down
81 changes: 30 additions & 51 deletions docs/ides/configuring-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,36 @@
# Configuring JetBrains Gateway

The following screenshots outline in more detail how to create a new Connection
for JetBrains Gateway to a Coder workspace.
The following walkthrough details how to connect JetBrains Gateway to
Coder.

## Creating a new JetBrains Gateway Connection

After installing Gateway on your local system, you may connect to a Coder
workspace as follows

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"
2. Click "New Connection"

![Gateway Home](../images/gateway/gateway-home.png)

3. In the resulting dialog, click the gear icon to the right of "Connection:"

![Gateway New Connection](../images/gateway/gateway-new-connection.png)

4. 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.<workspace name>`
2. For the Port, enter `22` (this is ignored by Coder)
3. For the Username, enter `coder`
4. For the Authentication Type, select "OpenSSH config and authentication
agent"
5. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
6. Click "Test Connection" to ensure you setting are ok.
7. Click "OK"

![Gateway SSH
Configuration](../images/gateway/gateway-create-ssh-configuration.png)

5. Select the connection you just added.

![Gateway Welcome](../images/gateway/gateway-welcome.png)

6. Click "Check Connection and Continue"

![Gateway Continue](../images/gateway/gateway-continue.png)

7. Select the JetBrains IDE for your project and the project directory
1. Use an SSH terminal to your workspace to create a directory or check out
code if you haven't already.

> Note the JetBrains IDE is installed in the directory `~/.
> cache/JetBrains/RemoteDev/dist`

![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)

8. Click "Download and Start IDE" to connect.

![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.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. For the Host, enter `coder.<workspace name>`
1. For the Port, enter `22` (this is ignored by Coder)
1. For the Username, enter `coder`
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/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)
4 changes: 2 additions & 2 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@
"path": "./ides/configuring-web-ides.md"
},
{
"title": "Configuring Jetbrains Gateway",
"description": "Learn how to configure Jetbrains Gateway for your workspaces",
"title": "Configuring JetBrains Gateway",
"description": "Learn how to configure JetBrains Gateway for your workspaces",
"path": "./ides/configuring-gateway.md"
}
]
Expand Down