Marcin Tojek
c301a0d804
docs: add comprehensive Web Terminal documentation ( #20458 )
...
Fixes: https://github.com/coder/coder/issues/19119
2025-10-24 16:24:53 +02:00
Atif Ali
1cb2ac65e5
chore: remove a redundant letter from docs ( #20443 )
2025-10-23 22:02:34 +05:00
Rowan Smith
e0b1536075
chore: clarify autostop behaviour for existing workspaces ( #20295 )
...
[We have tests to ensure this
behaviour](https://github.com/coder/coder/blob/152103bf788dc5a4c06586302a255a212e0fe77d/coderd/workspaces_test.go#L2957-L3004 ),
but it is not clearly documented. This PR adds a note clarifying
autostop must be enabled on the template prior to a workspace being
created for it to apply to the workspace, i.e. it is not re-read if a
workspace is restarted / stopped and started. This behaviour was raised
by a customer.
https://coder.com/docs/user-guides/workspace-scheduling#autostop
2025-10-15 08:46:27 +05:00
Ethan
659f237737
docs: add next steps to coder desktop guide ( #19975 )
...
I ended up on the Coder Desktop docs page and thought half of it had disappeared, though it was actually tucked away behind a second page. This PR adds a next steps section to the first page that links there, as it seems very easy to miss right now.
2025-09-26 14:06:59 +10:00
f402ec99eb
docs: fix typo in Coder Desktop Guide ( #19742 )
...
If you have used AI to produce some or all of this PR, please ensure you
have read our [AI Contribution
guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING )
before submitting.
Fix a quick typo that was introduced in
https://github.com/coder/coder/commit/8f72538ab7cbcdf23680f4916121ceca0f325e97
---------
Co-authored-by: Prebuilds Owner <prebuilds@system>
Co-authored-by: Atif Ali <atif@coder.com >
Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com >
2025-09-09 15:05:09 +00:00
Atif Ali and david-fraley
8f72538ab7
docs: reorganize Coder Desktop docs ( #18871 )
...
Co-authored-by: david-fraley <67079030+david-fraley@users.noreply.github.com >
2025-09-05 06:17:47 +00:00
Ethan
c6d62e2de1
docs: update coder desktop + corporate vpn issue ( #19353 )
...
I missed this in my first PR 😮💨 . We already include the
version requirements for the VPN fix in the `Known Issues` section.
2025-08-14 15:06:41 +10:00
Ethan
1ffc5a0e97
docs: update status of coder desktop + corporate vpn issue ( #19350 )
...
A customer read this on the docs and thought the issue was still
unresolved.
2025-08-14 04:17:25 +00:00
Edward Angert and EdwardAngert
428ec351fe
docs: add code-server/vs code web comparison table ( #19104 )
...
closes #18815
adds a doc with comparison table and links to main documentation for
code-server
[preview](https://coder.com/docs/@18815-code-server-vs/user-guides/workspace-access/code-server )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-07-30 12:35:27 -04:00
Andrew Aquino
72b8ab530e
fix(docs): add missing GFM alert directives to blockquotes ( #19042 )
...
I just added support for rendering GFM alerts inside of numbered lists
in coder.com (see https://github.com/coder/coder.com/pull/328 ), and
noticed that these plain blockquotes should probably be alerts.
This should cover all the missing alerts. I found them by searching for
the regex `^\s*>\s` within docs/**/*.md
Is `[!NOTE]` the correct type for these? Or do we want to use
tip/important/etc?
- @mtojek CONTRIBUTING.md
- @johnstcn support-bundle.md
- @matifali gateway.md
2025-07-28 15:00:56 -07:00
ca6b5e3415
docs: update port forwarding docs to include Coder Desktop ( #18870 )
...
Noticed that Coder Desktop was missing from port-forwarding docs which
is kind of a big feature for Coder Connect.
[preview](https://coder.com/docs/@atif%2Fdesktop-ports/user-guides/workspace-access/port-forwarding )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-07-16 19:57:55 +00:00
7cf3263fbd
docs: document issue with macos coder desktop behind vpn ( #18855 )
...
docs for https://github.com/coder/coder-desktop-macos/issues/201 and
https://github.com/coder/coder-desktop-windows/issues/147
> If the logged in Coder deployment requires a VPN to connect, Coder
Connect can't establish communication through the VPN,
> and will time out.
[preview](https://coder.com/docs/@201-desktop-mac-vpn/user-guides/desktop )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Dean Sheather <dean@deansheather.com >
2025-07-14 12:33:48 -04:00
Edward Angert and EdwardAngert
e3627fd562
docs: fix markdown in Windsurf doc ( #18753 )
...
hotfix
[preview](https://coder.com/docs/@18705-windsurf-md/user-guides/workspace-access/windsurf )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-07-07 18:52:19 +05:00
Atif Ali
aad14b8a6b
docs: add RDP desktop button gif ( #18758 )
...
Forgot to add this in #18716
2025-07-06 20:15:37 +05:00
Atif Ali
ca13b58d57
docs: reorganize remote desktop docs ( #18716 )
...
- Reorganize each option in two sections: Web and Desktop Client
- Moves the warning about UDP connections to the bottom
- Move Coder Desktop as the first option
- Links the Coder Desktop RDP module
Preview:
https://coder.com/docs/@remote-desktop-module/user-guides/workspace-access/remote-desktops
2025-07-06 15:46:15 +05:00
blink-so[bot] and bpmct
91aa583ea4
docs: mention Windsurf module in Windsurf documentation ( #18715 )
...
Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com>
Co-authored-by: bpmct <22407953+bpmct@users.noreply.github.com >
2025-07-02 19:13:35 +05:00
Atif Ali and Edward Angert
0b8ed9c2bd
docs: move the duplicate Coder Desktop install warning to Troubleshooting ( #18691 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-07-02 11:22:58 +00:00
Vladislav Rudskoy
715c7b0c24
chore: correct RD limitation comment ( #18668 )
...
subj
2025-06-30 22:46:00 +05:00
b1e8d5d5e0
docs: remove beta label from Coder Desktop ( #18651 )
...
Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com>
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-06-30 21:23:09 +05:00
Atif Ali and Spike Curtis
fb0e7a21a7
docs: add Coder Desktop to remote desktop docs ( #18326 )
...
Co-authored-by: Spike Curtis <spike@coder.com >
2025-06-26 11:16:41 +05:00
Atif Ali
b5316d2b42
docs: fix a warning alert type on toolbox docs ( #18560 )
2025-06-25 08:21:12 +00:00
Atif Ali
9c1feffded
docs: add troubleshooting section to JetBrains Toolbox docs ( #18394 )
2025-06-20 20:00:56 +05:00
ケイラ
5df70a613d
feat: add organization scope for shared ports ( #18314 )
2025-06-16 16:15:59 -06:00
Spike Curtis
86c29770e8
docs: warn about RDP over UDP with Coder Desktop ( #18354 )
...
Warns about UDP incompatibility for Coder Connect and RDP over UDP; explains how to disable.
Fixes https://github.com/coder/internal/issues/608
[preview](https://coder.com/docs/@spike%2Finternal-608-rdp-udp-docs/user-guides/workspace-access/remote-desktops#coder-desktop-beta )
2025-06-16 19:30:22 +04:00
Atif Ali and Edward Angert
acf7d86edd
docs: add winget installation step to Coder Desktop Windows ( #18325 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-06-15 21:41:29 +05:00
Edward Angert and EdwardAngert
f1cca03ed3
docs: reorganize the About section ( #18236 )
...
As part of an information architecture overhaul, this PR reorganizes the
About section and adds a Support section (but not content to it yet)
[preview](https://coder.com/docs/@docs-ia-about/about )
this PR is intentionally limited in scope so that we can ship meaningful
changes faster and followup PRs should include:
- [ ] edit + overhaul the About page
- [ ] decide on the `start` directory
- [ ] ~screenshots page updates~ (this should happen July or later)
redirects PR: https://github.com/coder/coder.com/pull/944
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-06-12 13:56:45 -04:00
Edward Angert and EdwardAngert
60927c701d
docs: edit troubleshooting steps in Coder Desktop documentation ( #18233 )
...
closes #18071
- [x] move `## Accessing web apps in a secure browser context` to the
troubleshooting section
- [x] use a compacted view for troubleshooting topics to prevent them
from occupying a significant space on page
- [x] remove `Issues updating Coder Desktop`
- [x] Update screenshots
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-06-04 13:58:30 -04:00
Edward Angert and EdwardAngert
63adfa57bd
docs: add link to official jetbrains toolbox ( #18128 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-06-03 15:49:34 -04:00
Atif Ali
4a2b243fc1
docs: improve JetBrains Toolbox connection docs ( #18125 )
2025-06-03 12:04:43 +05:00
Atif Ali and EdwardAngert
25e2146200
docs: reorganize JetBrains docs ( #17995 )
...
This pull request introduces significant updates to documentation and
references related to JetBrains IDEs, including rebranding,
restructuring, and adding new guides.
[Preview](https://coder.com/docs/@atif%2Fjetbrains-reorganization )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-29 17:56:44 -07:00
Edward Angert and EdwardAngert
e906ce2b65
docs: separate coder desktop sections into install and use pages ( #18068 )
...
[preview](https://coder.com/docs/@coder-desktop-section/user-guides/desktop )
we should consider the "Connect" naming in future PRs
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-29 17:42:14 +00:00
eb8013a7f4
docs: add jetbrains toolbox steps ( #17661 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: ケイラ <mckayla@hey.com >
Co-authored-by: Jon Ayers <jon@coder.com >
Co-authored-by: Danny Kopping <danny@coder.com >
Co-authored-by: Michael Suchacz <203725896+ibetitsmike@users.noreply.github.com >
Co-authored-by: Bruno Quaresma <bruno@coder.com >
Co-authored-by: Steven Masley <stevenmasley@gmail.com >
Co-authored-by: Atif Ali <atif@coder.com >
2025-05-22 16:08:59 +05:00
Spike Curtis
cbbbb4492a
docs: explain coder:// link for RDP ( #17901 )
...
fixes https://github.com/coder/internal/issues/627
Adds docs for `coder://` URLs for Windows Remote Desktop (RDP).
Note that we might want to hold of merging since the URI handling is
unreleased in Coder Desktop for Windows.
2025-05-21 09:28:31 +04:00
Spike Curtis
7f9ddd73c5
docs: remove link to closed Remote Desktop issue ( #17881 )
...
There is a link in our docs saying Remote Desktop is on the roadmap, but the issue is closed.
2025-05-16 16:08:59 +04:00
brettkolodny and M Atif Ali
73251cf5b2
chore: add documentation to the coder ssh command regarding feature parity with ssh ( #17827 )
...
Closes
[coder/internal#628 ](https://github.com/coder/internal/issues/628 )
---------
Co-authored-by: M Atif Ali <atif@coder.com >
2025-05-14 15:42:44 -04:00
Edward Angert and EdwardAngert
74934e174e
docs: add file sync to coder desktop docs ( #17463 )
...
closes #16869
section could use more about:
- [x] sync direction options?
- [x] how to resolve conflicts
- [x] EA --> Beta
[preview](https://coder.com/docs/@16869-desktop-file-sync/user-guides/desktop )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-14 10:05:33 -04:00
Mathias Fredriksson and EdwardAngert
a226a75b32
docs: add early access dev container docs ( #17613 )
...
This change documents the early access dev containers integration and
how to enable it, what features are available and what limitations exist
at the time of writing.
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-01 23:45:02 +01:00
Edward Angert and EdwardAngert
0cd531dd33
docs: document workspace naming rules and restrictions ( #17312 )
...
closes #12047
[preview](https://coder.com/docs/@12047-workspace-names/user-guides/workspace-management )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-15 14:11:05 -04:00
6330b0d545
docs: add steps to pre-install JetBrains IDE backend ( #15962 )
...
closes #13207
[preview](https://coder.com/docs/@13207-preinstall-jetbrains/user-guides/workspace-access/jetbrains )
---------
Co-authored-by: M Atif Ali <atif@coder.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-11 11:55:04 -04:00
0e878a8e98
docs: rename codervpn to coder connect ( #16833 )
...
part of: https://github.com/coder/internal/issues/459
- [x] Text
- [x] Screenshots
- [x] MacOS
- [x] Windows
[preview](https://coder.com/docs/@459-coder-connect/user-guides/desktop )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-04-08 12:00:23 +04:00
Edward Angert and EdwardAngert
d0aff04aef
docs: remove blank inbox doc ( #17285 )
...
[preview](https://coder.com/docs/@hotfix-inbox-doc )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-07 14:19:45 -04:00
Edward Angert and EdwardAngert
0fe7346264
docs: remove enterprise from docs ( #17226 )
...
Enterprise is a legacy plan that has been replaced by Premium.
[preview](https://coder.com/docs/@enterprise-feats )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-02 16:51:57 -04:00
Edward Angert and EdwardAngert
0125ff4592
docs: add new workspace notifications dashboard and config ( #16548 )
...
closes #16511
[preview](https://coder.com/docs/@16511-dashboard-vscode-notif/admin/monitoring/notifications )
(beta tag is removed in https://github.com/coder/coder/pull/17096 )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-01 21:03:55 -05:00
037dbc84da
docs: add new cursor and windsurf docs ( #17092 )
...
closes #16919
- [x] cursor doc
- [x] windsurf doc
from
https://github.com/coder/coder/issues/16919#issuecomment-2737033477 :
- add to access-workspace
- link to module(s)
- how to windsurf with ssh
- temp: install vsix manually (Windsurf)
- from <https://github.com/coder/vscode-coder >
- log in first
- search extensions for Coder
- ask your admin to add a module:
https://registry.coder.com/modules/cursor
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-04-01 20:13:32 +05:00
6bb4bdb9cb
docs: add troubleshooting section to Desktop docs ( #17098 )
...
[preview](https://coder.com/docs/@121-desktop-troubleshoot/user-guides/desktop )
relates to https://github.com/coder/coder-desktop-macos/issues/121
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com >
2025-03-26 19:00:32 +00:00
Edward Angert and EdwardAngert
bbe7dacd35
docs: document definition of workspace activity ( #16941 )
...
closes: https://github.com/coder/coder/issues/16884
aligns the documentation with what users see when they adjust settings
and uses the [notion
discussion](https://www.notion.so/coderhq/Definitions-of-Workspace-Usage-Autostop-Dormancy-e7fa8ff782a948c19bbe4ef8315c26cb )
as a reference. This PR reflects current behavior from what I can tell.
[preview](https://coder.com/docs/@16884-define-activity/user-guides/workspace-scheduling#activity-detection )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-21 10:36:24 -04:00
Edward Angert and EdwardAngert
8ca52a835e
docs: document steps for adding cert to JetBrains plugin settings ( #16882 )
...
- document the steps from @stirby in ticket
- separate the different OSs in a way that's easier to look at
- fix typo
[preview](https://coder.com/docs/@593-ca-cert-plugin/user-guides/workspace-access/jetbrains#configuring-the-gateway-plugin-to-use-internal-certificates )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-17 17:11:36 -04:00
Ethan
4994ba1e60
docs: remove broken gfm alert ( #16902 )
...
It looks like GFM does not respect the `![]` alert syntax (and any other
alert type) when it's enclosed within a div. This is true for both the
coder.com GFM renderer, and GitHub's (though I assume they're the same
internally).
When the section is surrounded by a `<div class="tabs">`:
When it's not:
In our case, we really want the tabs, and the alert block is less
important, so we'll downgrade it to a regular quote.
cc @aqandrew for visibility, in case you're aware of a workaround.
2025-03-13 16:13:02 +11:00
Ethan
f899832c02
docs: add warning for multiple Coder Desktop mac installations ( #16888 )
...
I realised we should advise against installing multiple copies, as I'm sure someone will try and get confused by Apple's obtuse error messaging.
Tailscale also has a similar warning: https://pkgs.tailscale.com/stable/#macos
2025-03-13 14:45:37 +11:00
101b62dc3e
docs: convert alerts to use GitHub Flavored Markdown (GFM) ( #16850 )
...
followup to #16761
thanks @lucasmelin !
+ thanks: @ethanndickson @Parkreiner @matifali @aqandrew
- [x] update snippet
- [x] find/replace
- [x] spot-check
[preview](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule )
(and others)
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-03-10 16:58:20 -04:00
Marcin Tojek