Skip to content

chore: move Code With Me docs to IDEs page #441

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.

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 3 commits into from
Jun 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 0 additions & 3 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@
{
"path": "./workspaces/autostart.md"
},
{
"path": "./workspaces/code-with-me.md"
},
{
"path": "./workspaces/devurls.md"
},
Expand Down
99 changes: 0 additions & 99 deletions workspaces/code-with-me.md

This file was deleted.

103 changes: 99 additions & 4 deletions workspaces/editors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ description:
Learn how to connect your favorite editors and IDEs to your remote workspace.
---

There are four primary ways you can connect an IDE to your Coder workspace:
There are five primary ways you can connect an IDE to your Coder workspace:

1. [VS Code remote SSH](#vs-code-remote-ssh) with local VS Code
1. [VS Code in the browser](#vs-code-in-the-browser) with code-server
1. [JetBrains in the browser](##jetbrains-ides-in-the-browser) with JetBrains
1. [VS Code remote SSH](editors.md#vs-code-remote-ssh) with local VS Code
1. [VS Code in the browser](editors.md#vs-code-in-the-browser) with code-server
1. [JetBrains in the browser](editors.md#jetbrains-ides-in-the-browser) with JetBrains
Projector
1. [JetBrains' Code With Me](editors.md#code-with-me)
1. _Any_ local editor with
[1-way file synchronization](../cli/file-sync.md#one-way-file-sync) or
[2-way file synchronization over SSH](../cli/file-sync.md#two-way-file-sync)
Expand Down Expand Up @@ -83,3 +84,97 @@ workspace with the following resources at a minimum:
- Popup windows are missing titles and window controls
- Some theme-based plugins can cause the IDE to render incorrectly
- Some minor rendering artifacts occur during regular usage

## Code With Me

[JetBrains' Code With Me](https://www.jetbrains.com/code-with-me/) allows you to
collaborate with others in real-time on your project and enables pair
programming.

> You must have a [JetBrains IDE
installed](../admin/workspace-management/installing-jetbrains.md) onto your
[image](../images/index.md) to use Code With Me.

### Getting started

To set up a Code With Me session:

1. The host creates a session and shares the information needed to join the
session with other participants.
1. The participants use the information provided by the host to join the session
and request access.
1. The host accepts the participants' request to join the session created
by the host.

#### Step 1: Start and host a session

To create and host a Code With Me session:

1. Log in to Coder.

1. Under **Applications**, launch the JetBrains IDE (e.g., GoLand) of your
choice.

![Launch IDE](../assets/workspaces/code-with-me-1.png)

1. Click the **Code With Me** icon at the top of your IDE.

![Code With Me icon](../assets/workspaces/code-with-me-2.png)

1. Select **Enable Access and Copy Invitation Link...**.

![Enable access and copy link](../assets/workspaces/code-with-me-3.png)

1. Confirm and accept the Terms of Use.

1. Set the permissions for new guests to **Full access** and uncheck the
**Automatically start voice call** feature. Click **Enable Access**.

![Set permissions](../assets/workspaces/code-with-me-4.png)

1. Once you've enabled access, JetBrains copies the link you must share with
participants to your clipboard. Send this link to those with whom you'd like
to collaborate.

You can recopy this link at any time by clicking the **Code With Me icon**
and choosing **Copy Invitation Link...**.

![Link confirmation](../assets/workspaces/code-with-me-5.png)

#### Step 2: Request to join the session

If you've received a link to join a Code With Me session as a participant:

1. Copy the Code With Me session link that you were provided, and paste it into
your web browser. You'll be directed to a webpage with further instructions.

1. On the instructions page to which you were directed, copy the code snippet
and run it in the terminal.

![Run join command in terminal](../assets/workspaces/code-with-me-6.png)

1. Confirm and accept the User Agreement.

1. You'll be shown a **security code**. Verify with the host of your session
that they see the same code.

![Security code verification](../assets/workspaces/code-with-me-7.png)

1. Wait for your host to accept your request to join; when they do, your
JetBrains IDE will launch automatically.

![New JetBrains IDE](../assets/workspaces/code-with-me-8.png)

#### Step 3: Accept the request to the join

If you're the host of the session, you'll see a request that the other
participant wants to join your project, the permissions you've
granted to the other user, and a security code.

![Security code verification for host](../assets/workspaces/code-with-me-9.png)

Verify that the security code you see matches the one shown to your
participants. If they do, click **Accept** to proceed.

At this point, you'll be able to share your project and work with your partner
in real-time.