Skip to content

Commit 71e77b0

Browse files
matifalimatifali
committed
Update JetBrains integration docs and rename files
- Add new information on JetBrains Toolbox and Fleet integration. - Rename files for better organization and to reflect content changes. - Remove outdated JetBrains Gateway documentation and consolidate info. - Adjust paths and links for offline support in JetBrains IDEs. - Update manifest for consistency and navigation improvements.
1 parent 5a3a7fc commit 71e77b0

File tree

10 files changed

+261
-371
lines changed

10 files changed

+261
-371
lines changed

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,10 @@ We are always working on new integrations. Please feel free to open an issue and
109109
### Official
110110

111111
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click
112-
- [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
112+
- [**JetBrains Toolbox Plugin**](https://plugins.jetbrains.com/plugin/26968-coder): Open any Coder workspace from JetBrains Toolbox with a single click
113+
- [**JetBrains Gateway Plugin**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
113114
- [**Dev Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift
114-
- [**Module Registry**](https://registry.coder.com): Extend development environments with common use-cases
115+
- [**Coder Registry**](https://registry.coder.com): Build and extend development environments with common use-cases
115116
- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs
116117
- [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server).
117118
- [**Setup Coder**](https://github.com/marketplace/actions/setup-coder): An action to setup coder CLI in GitHub workflows.

docs/user-guides/workspace-access/jetbrains/jetbrains-airgapped.md renamed to docs/admin/templates/extending-templates/jetbrains-airgapped.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JetBrains Gateway in an air-gapped environment
1+
# JetBrains IDEs in an air-gapped environment
22

33
In networks that restrict access to the internet, you will need to leverage the
44
JetBrains Client Installer to download and save the IDE clients locally. Please
@@ -161,4 +161,4 @@ respectively.
161161

162162
## Next steps
163163

164-
- [Pre-install the JetBrains IDEs backend in your workspace](../../../admin/templates/extending-templates/jetbrains-gateway.md)
164+
- [Pre-install the JetBrains IDEs backend in your workspace](./jetbrains-preinstall.md)

‎docs/admin/templates/extending-templates/jetbrains-gateway.md‎

Lines changed: 0 additions & 119 deletions
This file was deleted.

docs/user-guides/workspace-access/jetbrains/jetbrains-pre-install.md renamed to docs/admin/templates/extending-templates/jetbrains-preinstall.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Pre-install JetBrains Gateway in a template
1+
# Pre-install JetBrains IDEs in your template
22

3-
For a faster JetBrains Gateway experience, pre-install the IDEs backend in your template.
3+
For a faster first time connection with JetBrains IDEs, pre-install the IDEs backend in your template.
44

55
> [!NOTE]
66
> This guide only talks about installing the IDEs backend. For a complete guide on setting up JetBrains Gateway with client IDEs, refer to the [JetBrains Gateway air-gapped guide](./jetbrains-airgapped.md).
@@ -40,7 +40,7 @@ Add the following command to your template's `startup_script`:
4040

4141
## Configure JetBrains Gateway Module
4242

43-
If you are using our [jetbrains-gateway](https://registry.coder.com/modules/jetbrains-gateway) module, you can configure it by adding the following snippet to your template:
43+
If you are using our [jetbrains-gateway](https://registry.coder.com/modules/coder/jetbrains-gateway) module, you can configure it by adding the following snippet to your template:
4444

4545
```tf
4646
module "jetbrains_gateway" {
@@ -116,4 +116,4 @@ RUN mkdir -p ~/JetBrains \
116116

117117
## Next steps
118118

119-
- [Pre install the Client IDEs](./jetbrains-airgapped.md#1-deploy-the-server-and-install-the-client-downloader)
119+
- [Pre-install the Client IDEs](./jetbrains-airgapped.md#1-deploy-the-server-and-install-the-client-downloader)

‎docs/install/offline.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ Coder is installed.
253253
## JetBrains IDEs
254254

255255
Gateway, JetBrains' remote development product that works with Coder,
256-
[has documented offline deployment steps.](../user-guides/workspace-access/jetbrains/jetbrains-airgapped.md)
256+
[has documented offline deployment steps.](../admin/templates/extending-templates/jetbrains-airgapped.md)
257257

258258
## Microsoft VS Code Remote - SSH
259259

‎docs/manifest.json‎

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,18 +136,19 @@
136136
},
137137
{
138138
"title": "JetBrains IDEs",
139-
"description": "Use JetBrains IDEs with Gateway",
139+
"description": "Use JetBrains IDEs with Coder",
140140
"path": "./user-guides/workspace-access/jetbrains/index.md",
141141
"children": [
142142
{
143-
"title": "JetBrains Gateway in an air-gapped environment",
144-
"description": "Use JetBrains Gateway in an air-gapped offline environment",
145-
"path": "./user-guides/workspace-access/jetbrains/jetbrains-airgapped.md"
143+
"title": "JetBrains Gateway",
144+
"description": "Use JetBrains Gateway to connect to Coder workspaces",
145+
"path": "./user-guides/workspace-access/jetbrains/gateway.md"
146146
},
147147
{
148148
"title": "JetBrains Toolbox",
149-
"description": "Access Coder workspaces through JetBrains Toolbox",
150-
"path": "./user-guides/workspace-access/jetbrains/jetbrains-toolbox.md"
149+
"description": "Access Coder workspaces from JetBrains Toolbox",
150+
"path": "./user-guides/workspace-access/jetbrains/toolbox.md",
151+
"state": ["beta"]
151152
}
152153
]
153154
},
@@ -489,9 +490,14 @@
489490
"path": "./admin/templates/extending-templates/web-ides.md"
490491
},
491492
{
492-
"title": "Pre-install JetBrains Gateway",
493-
"description": "Pre-install JetBrains Gateway in a template for faster IDE startup",
494-
"path": "./admin/templates/extending-templates/jetbrains-gateway.md"
493+
"title": "Pre-install JetBrains IDEs",
494+
"description": "Pre-install JetBrains IDEs in a template for faster IDE startup",
495+
"path": "./admin/templates/extending-templates/jetbrains-preinstall.md"
496+
},
497+
{
498+
"title": "JetBrains IDEs in Air-Gapped Deployments",
499+
"description": "Configure JetBrains IDEs for air-gapped deployments",
500+
"path": "./admin/templates/extending-templates/jetbrains-airgapped.md"
495501
},
496502
{
497503
"title": "Docker in Workspaces",
@@ -912,6 +918,16 @@
912918
"description": "Learn how to use NGINX as a reverse proxy",
913919
"path": "./tutorials/reverse-proxy-nginx.md"
914920
},
921+
{
922+
"title": "Pre-install JetBrains IDEs in Workspaces",
923+
"description": "Pre-install JetBrains IDEs in workspaces",
924+
"path": "./admin/templates/extending-templates/jetbrains-preinstall.md"
925+
},
926+
{
927+
"title": "Use JetBrains IDEs in Air-Gapped Deployments",
928+
"description": "Configure JetBrains IDEs for air-gapped deployments",
929+
"path": "./admin/templates/extending-templates/jetbrains-airgapped.md"
930+
},
915931
{
916932
"title": "FAQs",
917933
"description": "Miscellaneous FAQs from our community",

‎docs/user-guides/workspace-access/jetbrains/fleet.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# JetBrains Fleet
2+
3+
JetBrains Fleet is a code editor and lightweight IDE designed to support various
4+
programming languages and development environments.
5+
6+
[See JetBrains's website](https://www.jetbrains.com/fleet/) to learn more about Fleet.
7+
8+
To connect Fleet to a Coder workspace:
9+
10+
1. [Install Fleet](https://www.jetbrains.com/fleet/download)
11+
12+
1. Install Coder CLI
13+
14+
```shell
15+
curl -L https://coder.com/install.sh | sh
16+
```
17+
18+
1. Login and configure Coder SSH.
19+
20+
```shell
21+
coder login coder.example.com
22+
coder config-ssh
23+
```
24+
25+
1. Connect via SSH with the Host set to `coder.workspace-name`
26+
![Fleet Connect to Coder](../../../images/fleet/ssh-connect-to-coder.png)

0 commit comments

Comments
 (0)