Skip to content

docs: remove configuring prefix from IDEs #3446

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
Aug 10, 2022
Merged

docs: remove configuring prefix from IDEs #3446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc2de93
docs: remove configuring prefix from IDEs
ammario Aug 10, 2022
14cea7c
fixup! docs: remove configuring prefix from IDEs
ammario Aug 10, 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
10 changes: 5 additions & 5 deletions docs/ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +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)
- [JetBrains with Gateway](./ides/configuring-gateway.md)
- [JetBrains with Gateway](./ides/gateway.md)
- IntelliJ IDEA
- CLion
- GoLand
Expand All @@ -13,8 +13,8 @@ support should work:
- RubyMine
- WebStorm
- Web IDEs (code-server, JupyterLab, JetBrains Projector)
- Note: These are [configured in the template](./ides/configuring-web-ides.md)
- [Emacs](./ides/configuring-emacs-tramp.md)
- Note: These are [configured in the template](./ides/web-ides.md)
- [Emacs](./ides/emacs-tramp.md)

## SSH configuration

Expand Down Expand Up @@ -67,7 +67,7 @@ already done so, you may wish to open a terminal on your Coder workspace and
check out a copy of the project you intend to work on.

After installing Gateway on your local system, [follow these steps to create a
Connection and connect to your Coder workspace.](./ides/configuring-gateway.md)
Connection and connect to your Coder workspace.](./ides/gateway.md)

| Version | Status | Notes |
| --------- | ------- | -------------------------------------------------------- |
Expand All @@ -77,7 +77,7 @@ Connection and connect to your Coder workspace.](./ides/configuring-gateway.md)

## Web IDEs (Jupyter, code-server, JetBrains Projector)

Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [configuring IDEs](./ides/configuring-web-ides.md).
Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [IDEs](./ides/web-ides.md).

## Up next

Expand Down
2 changes: 1 addition & 1 deletion docs/ides/configuring-emacs-tramp.md → docs/ides/emacs-tramp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuring Emacs TRAMP
# Emacs TRAMP

[Emacs TRAMP](https://www.emacswiki.org/emacs/TrampMode) is a method of running editing operations on a remote server.

Expand Down
2 changes: 1 addition & 1 deletion docs/ides/configuring-gateway.md → docs/ides/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuring JetBrains Gateway
# JetBrains Gateway

The following walkthrough details how to connect JetBrains Gateway to
Coder.
Expand Down
2 changes: 1 addition & 1 deletion docs/ides/configuring-web-ides.md → docs/ides/web-ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuring web IDEs
# Web IDEs

By default, Coder workspaces allow connections via:

Expand Down
12 changes: 6 additions & 6 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,19 @@
"icon_path": "./images/icons/terminal.svg",
"children": [
{
"title": "Configuring Web IDEs",
"title": "Web IDEs",
"description": "Learn how to configure web IDEs in your templates",
"path": "./ides/configuring-web-ides.md"
"path": "./ides/web-ides.md"
},
{
"title": "Configuring JetBrains Gateway",
"title": "JetBrains Gateway",
"description": "Learn how to configure JetBrains Gateway for your workspaces",
"path": "./ides/configuring-gateway.md"
"path": "./ides/gateway.md"
},
{
"title": "Configuring Emacs",
"title": "Emacs",
"description": "Learn how to configure Emacs with TRAMP in Coder",
"path": "./ides/configuring-emacs-tramp.md"
"path": "./ides/emacs-tramp.md"
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Coder with Docker has the following advantages:
## Next Steps

- [Learn more about template configuration](../templates.md)
- [Configure more IDEs](../ides/configuring-web-ides.md)
- [Configure more IDEs](../ides/web-ides.md)
2 changes: 1 addition & 1 deletion docs/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ resources associated with the workspace.
### Coder apps

By default, all templates allow developers to connect over SSH and a web
terminal. See [Configuring Web IDEs](./ides/configuring-web-ides.md) to
terminal. See [Configuring Web IDEs](./ides/web-ides.md) to
learn how to give users access to additional web applications.

### Data source
Expand Down