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
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
Edward Angert and EdwardAngert
db806ae243
docs: move early access badge in dynamic parameters doc ( #18009 )
...
and md fix
this is basically a `hotfix`
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-27 15:17:49 +02: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
Edward Angert and EdwardAngert
1f54c36375
docs: rename external-auth heading in setup doc ( #17868 )
...
to help point searchers to the correct doc
[preview](https://coder.com/docs/@setup-ext-auth/admin/setup#continue-your-setup-with-external-authentication )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-20 15:10:52 -04:00
Edward Angert and EdwardAngert
b51c902e48
docs: add early access badge to devcontainers admin ( #17937 )
...
[preview](https://coder.com/docs/@dev-container-tweaks/admin/templates/extending-templates/devcontainers )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-20 12:46:07 -04:00
1314dbdc94
docs: add new dynamic parameters information to parameters doc ( #17653 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com >
Co-authored-by: Stephen Kirby <kirby@coder.com >
Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com >
2025-05-19 21:23:53 +00:00
Edward Angert
c42a3156cc
docs: add dev containers to manifest.json ( #17854 )
...
[preview](http://coder.com/docs/@dev-container-manifest/admin/templates/extending-templates/devcontainers )
2025-05-15 13:18:21 +00: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
f9817af11f
docs: add section on how to retrieve user list ( #17798 )
...
previews
- [admin/users](https://coder.com/docs/@export-coder-users/admin/users )
-
[reference/cli/users](https://coder.com/docs/@export-coder-users/reference/cli/users )
followup to slack thread:
> Tim
> what's the best way for customers to export a list of Coder users?
>
> @ericpaulsen
> the `/api/v2/users` API route returns all users in the deployment
(along with other information - email, status, username, etc.). from
<https://coder.com/docs/reference/api/users#get-users >
- adds an easy-to-find section to the admin/users doc
- updates the cli commands with short descriptions
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-05-13 20:48:16 +00:00
Edward Angert and EdwardAngert
bd659142c8
docs: add note about experiment_report_tasks to ai-coder/create-template ( #17563 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-09 21:00:18 +00:00
Edward Angert and EdwardAngert
5c532779af
docs: clarify parameter autofill documentation ( #17728 )
...
closes #17706
Clarify that:
1. URL query parameters work without experiment flag
2. The 'populate recently used parameters' feature still requires the
auto-fill-parameters experiment flag
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-09 13:01:11 -04:00
Edward Angert and EdwardAngert
9a052e2a4c
fix: use file filter in weekly-docs github action ( #17729 )
...
otherwise it ignores the instruction to only check docs/ when a file
changes in that dir
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-08 16:30:43 -04:00
912b6aba82
docs: link to eks steps from aws section ( #17646 )
...
closes #17634
---------
Co-authored-by: Claude <noreply@anthropic.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-02 15:13:42 +00:00
Edward Angert and EdwardAngert
50695b7d76
docs: fix link in tutorials faq to new docker-code-server link ( #17655 )
...
<https://github.com/sharkymark/v2-templates/tree/main/src/templates/docker/docker-code-server >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-05-02 13:44:30 +00:00
Edward Angert
ef101ae2a0
docs: update ai feature stage to beta and ease the intro note's tone ( #17620 )
...
[preview](https://coder.com/docs/@ai-feature-stage/ai-coder )
2025-04-30 15:20:44 +00:00
Edward Angert and EdwardAngert
3567d455a7
docs: fix ssh coder example in testing-templates doc ( #17550 )
...
from @NickSquangler and @angrycub on Slack
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-23 16:13:13 -04:00
Edward Angert and EdwardAngert
e6facaa41b
docs: clarify that parameter autofill requires experimental flag ( #17546 )
...
Update documentation to indicate that parameter autofill requires
`--experiments=auto-fill-parameters` enabled
Fixes #14673
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-23 17:13:08 +00:00
Edward Angert and EdwardAngert
5a7d531aef
docs: edit the ai agents doc ( #17521 )
...
general edit and adding some highlights as I work through the section
[preview](https://coder.com/docs/@ai-coder-edit/ai-coder/agents )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-23 11:14:57 -04:00
Edward Angert and EdwardAngert
9dea568027
docs: document GIT_ASKPASS for OAuth connections ( #17457 )
...
closes #17375
from @ericpaulsen
> a prospect recently inquired about how our OAuth integration with
GitLab works, and I realized we do not have any information on
`GIT_ASKPASS` is used to retreive the OAuth token for users when they
run `git` operations.
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-23 11:14:15 -04: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
Edward Angert and EdwardAngert
34752fa148
docs: add note about sign in with GitHub button should be hidden when flow is disabled ( #17367 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-14 17:03:25 +05: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
Edward Angert and EdwardAngert
9978eb63c4
docs: rename coder-ai directory to avoid wildcard removal ( #17348 )
...
to something that doesn't get caught in a wildcard redirect
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-10 16:21:20 -04:00
Edward Angert and EdwardAngert
c9682cb6cf
docs: hotfix rename coder-ai readme to index ( #17346 )
...
[preview](https://coder.com/docs/@hotfix-ai-coder-top/ )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-10 19:33:46 +00:00
Edward Angert and EdwardAngert
e5ba8b7912
docs: update aws instance recommendations ( #17344 )
...
from @jatcod3r on Slack:
> for the AWS recs on our [validated
arch](https://coder.com/docs/admin/infrastructure/validated-architectures/1k-users )
docs, should we be referencing customers to use non-T type instances?
> Once you've exceeded EC2's [CPU
credits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html )
Coder starts performing poorly.
> We do suggest to [scale for peak
demand](https://coder.com/docs/tutorials/best-practices/scale-coder#scaling-3 ),
so does recommending something from the
[cpu](https://aws.amazon.com/ec2/instance-types/#Compute_Optimized ) or
[memory
optimized](https://aws.amazon.com/ec2/instance-types/#Memory_Optimized )
types make sense?
[preview](https://coder.com/docs/@aws-ec2-arch/admin/infrastructure/validated-architectures#aws-instance-types )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-10 14:35:29 -04:00
Edward Angert and EdwardAngert
ed20bab3e0
docs: move AI-agent docs out of tutorials and into a top-level section ( #17231 )
...
redirects in: https://github.com/coder/coder.com/pull/873
[preview](https://coder.com/docs/@move-ai-agents-up-1/coder-ai )
- [x] icon
- [x] shorten ~Modify or truncate the current~ title ~to reduce its
length for improved readability, conciseness, or formatting
consistency.~
- [x] Best practices & adding tools via MCP - edit title, desc, headings
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-10 14:21:29 -04:00
Edward Angert and EdwardAngert
d17bcc727b
docs: update note markdown in parameters ( #17318 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-09 18:53:20 +00:00
+4
109e73bf97
docs: add details on external authentication priority ( #17164 )
...
## Issue
Closes #16875
Clarify how Coder authentication works with Git providers, particularly
the order of authentication methods used.
## Changes Made
I've updated the External Authentication documentation to:
1. Clarify that Coder first attempts to use external auth provider
tokens when available, and only defaults to SSH authentication if no
tokens are available
2. Add more detailed explanations about both authentication methods
3. Improve the description of how the `coder gitssh` command works with
existing and Coder-generated SSH keys
## Verification
Claude verified that this accurately describes the behavior of the
codebase by reviewing the `gitssh.go` implementation, which shows how
Coder handles SSH authentication as a fallback when external auth is not
available.
[preview](https://coder.com/docs/@16875-git-workspace-auth/admin/external-auth )
<sub>🤖 Generated with https://claude.ai/code </sub>
---------
Signed-off-by: dependabot[bot] <support@github.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Ben Potter <me@bpmct.net >
Co-authored-by: M Atif Ali <atif@coder.com >
Co-authored-by: Bruno Quaresma <bruno@coder.com >
Co-authored-by: Kyle Carberry <kyle@coder.com >
Co-authored-by: Cian Johnston <cian@coder.com >
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jon Ayers <jon@coder.com >
Co-authored-by: Hugo Dutka <hugo@coder.com >
Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com >
Co-authored-by: Michael Smith <throwawayclover@gmail.com >
Co-authored-by: Claude <noreply@anthropic.com >
Co-authored-by: Sas Swart <sas.swart.cdk@gmail.com >
2025-04-09 15:16:00 +00: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
2f6682a46f
docs: add zed code_app to extending-templates doc ( #17281 )
...
continuation of #17236 (thanks @sharkymark )
adds zed as a coder_app to
<https://coder.com/docs/admin/templates/extending-templates >
[preview](https://coder.com/docs/@17236-zed-app/admin/templates/extending-templates#coder-app-examples )
---------
Co-authored-by: sharkymark <mtm20176@gmail.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-07 14:00:43 -04:00
f475555d06
docs: document that default GitHub app requires device flow ( #17162 )
...
## Issue
Closes #16824
Document that the default GitHub authentication app provided by Coder
requires device flow, and that this behavior cannot be overridden.
## Changes Made
Claude updated the GitHub authentication documentation to:
1. Add a prominent warning in the Default Configuration section
explaining that the default GitHub app requires device flow and ignores
the `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting
2. Clarify the Device Flow section to indicate that:
- Device flow is always enabled for the default GitHub app
- Device flow is optional for custom GitHub OAuth apps
- The `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting is ignored when using
the default app
[preview](https://coder.com/docs/@16824-github-device-flow/admin/users/github-auth )
<sub>🤖 Generated with [Claude Code](https://claude.ai/code )</sub>
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Claude <noreply@anthropic.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-04-05 21:44:13 -04:00
Edward Angert and EdwardAngert
43d584c4f3
docs: add a section about latency and how it's measured ( #16734 )
...
closes https://github.com/coder/coder/issues/14942
- what latency is measured
- where it's reported
- how users experience latency
- how to lower latency
[preview](https://coder.com/docs/@14942-latency/admin/networking#latency )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-04 08:12:11 -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
0ec87abaa5
docs: add new section on managing provisioners from the dashboard ( #16563 )
...
closes #16513
[preview](https://coder.com/docs/@16513-manage-ext-provisioners/admin/provisioners/manage-provisioner-jobs )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-01 21:04:31 -05: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
Edward Angert and EdwardAngert
2efb8088f4
docs: remove beta badge from notifications doc ( #17096 )
...
remove beta from notifications doc
[preview](https://coder.com/docs/@notifications-beta/admin/monitoring/notifications )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-01 21:52:09 -04:00
900e125e4a
docs: update SMTP configuration in notifications docs ( #17161 )
...
## Issue
Closes #16206
(thanks @bjornrobertsson - not sure why I can't tag you as a reviewer)
Mismatch between the SMTP configuration UI and the documentation.
## Verification
Claude verified this issue by examining:
1. The current SMTP configuration code in the codebase
2. The CLI help documentation for the server command
3. The examples provided in the notifications documentation
The issue was confirmed by finding:
- A reference to a deprecated variable
`CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` instead of the current
`CODER_EMAIL_FORCE_TLS`
- Missing information about the port format required for the SMTP
smarthost
## Changes made
1. Updated the `--email-smarthost` description to clarify that the
format should include both hostname and port: `(format:
hostname:port)`
2. Fixed the reference to the TLS environment variable in the STARTTLS
description, replacing the deprecated
`CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` with the correct
`CODER_EMAIL_FORCE_TLS`
## Additional information
The Gmail and Outlook examples in the documentation already correctly
show the port included in the smarthost configuration, but the main
description table needed to be updated to explicitly mention this
requirement.
[preview](https://coder.com/docs/@16206-smtp-required-components/admin/monitoring/notifications )
<sub>🤖 Generated with [Claude Code](https://claude.ai/code )</sub>
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Claude <noreply@anthropic.com >
2025-04-01 14:44:09 -04: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
Edward Angert
c6799911dd
docs: edit workspace lifecycle description ( #17146 )
...
thanks for pointing this out, @jmshoffs0812 !
2025-03-28 07:24:33 -04: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
4983150ab9
docs: add a table to feature stages doc ( #17080 )
...
adds a table to the feature stages doc to summarize the stages + links
to the heading below for more info
[preview](https://coder.com/docs/@feature-stages-table/about/feature-stages )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-24 22:28:02 -04: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
c88d86bf50
docs: add new doc on how to deploy Coder on Rancher ( #16534 )
...
[preview](https://coder.com/docs/@deploy-on-rancher/install/rancher )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-19 18:50:52 +00:00
bd243c17fb
docs: add AWS AMI upgrade instructions ( #16973 )
...
followup to @d1str0's #16937
> Adds a small note for those who just used the AWS AMI for their
initial installation.
This PR rearranges the Upgrade doc to use tabs for each section + adds
AWS AMI
[preview](https://coder.com/docs/@upgrade-tabs/install/upgrade )
---------
Co-authored-by: Brady Sullivan <brady@bsull.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-19 10:10:58 -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
Edward Angert and EdwardAngert
ffd336b9ad
docs: adjust order of options in external-auth ( #16943 )
...
from @NickSquangler
> ($customer) noticed when setting up external auth with Gitlab that the
command listed in the docs is in the incorrect order, as `coder
external-auth <USER_DEFINED_ID> access-token` should be `coder
external-auth access-token <USER_DEFINED_ID>`
[preview](https://coder.com/docs/@external-auth-access-token/admin/external-auth#workspace-cli )
<details><summary>coder external-auth access-token --help</summary>
```shell
coder external-auth access-token --help
coder v2.20.0+03b5012
USAGE:
coder external-auth access-token [flags] <provider>
Print auth for an external provider
Print an access-token for an external auth provider. The access-token will be validated and sent
to stdout with exit code 0. If a valid access-token cannot be obtained, the URL to authenticate
will be sent to stdout with exit code 1
- Ensure that the user is authenticated with GitHub before cloning.:
$ #!/usr/bin/env sh
OUTPUT=$(coder external-auth access-token github)
if [ $? -eq 0 ]; then
echo "Authenticated with GitHub"
else
echo "Please authenticate with GitHub:"
echo $OUTPUT
fi
- Obtain an extra property of an access token for additional metadata.:
$ coder external-auth access-token slack --extra "authed_user.id"
OPTIONS:
--extra string
Extract a field from the "extra" properties of the OAuth token.
———
Run `coder --help` for a list of global options.
```
</details>
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-14 17:17:34 -04:00
a2131a7616
docs: add cgroup memory troubleshooting to install doc ( #16920 )
...
originally thought this fit under [Unofficial Install
Methods](https://coder.com/docs/install/other ), but we don't talk about
Raspberry Pi anywhere, so ~the general Install doc might be a better
fit~ moved to admin>templates>troubleshooting
[preview](https://coder.com/docs/@3-cgroup-mem/admin/templates/troubleshooting#coder-on-raspberry-pi-os )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-03-14 19:58:01 +00:00
Edward Angert and EdwardAngert
cf7d143e43
docs: use consistent examples in prometheus doc and add namespaceSelector spec ( #16918 )
...
closes : #15385
- use consistent `prom-http` port (@johnstcn looks like this was
changed/added in #12214 - do we prefer `prom-http` over
`prometheus-http` or is it more important that they align?)
- add `namespaceSelector:` per @francisco-mata (thanks! - sorry it took
so long to get this in)
from issue:
> For some reason our target was not appearing on our prometheus
targets, we had to add a namespaceSelector key on the Service Monitor to
successfully appear
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-13 22:09:26 -04: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
Edward Angert and EdwardAngert
f5aac64119
docs: add beta label to workspace presets ( #16826 )
...
thanks @ssncoder!
[preview](https://coder.com/docs/@workspace-presets-beta/admin/templates/extending-templates/parameters#workspace-presets )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-06 09:09:15 -05:00
Edward Angert and EdwardAngert
0913594bfc
docs: document workspace presets feature ( #16612 )
...
closes #16475
relates to #16304
- [x] reword opening sentence to clarify where this is done
- I think this is set because it's under parameters now
- [x] list of configurable settings
- same as above
- [x] (optional) screenshot
[preview](https://coder.com/docs/@16475-workspace-presets/admin/templates/extending-templates/parameters#workspace-presets )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-05 14:43:20 +05:00
Edward Angert and EdwardAngert
9251e0d642
docs: add oom/ood to notifications ( #16582 )
...
- [x] add section or to another section: where the notifications show
up/how to access
previews:
- [Notifications - Configure OOM/OOD
notifications](https://coder.com/docs/@16581-oom-ood-notif/admin/monitoring/notifications#configure-oomood-notifications )
- [Resource
monitoring](https://coder.com/docs/@16581-oom-ood-notif/admin/templates/extending-templates/resource-monitoring )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-03-05 14:43:08 +05:00
73057eb7bd
docs: add Coder Desktop early preview documentation ( #16544 )
...
closes #16540
closes https://github.com/coder/coder-desktop-macos/issues/75
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
Co-authored-by: Ethan Dickson <ethan@coder.com >
Co-authored-by: Dean Sheather <dean@deansheather.com >
2025-03-04 22:26:59 +05:00
Edward Angert and EdwardAngert
b3d675532f
docs: copy edit early access section in feature-stages doc ( #16730 )
...
- copy edit EA section with @mattvollmer 's suggestions
- ran the script that updates the list of experiments
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-27 09:20:03 +05:00
Edward Angert and EdwardAngert
5cdc13ba9e
docs: fix broken links in feature-stages ( #16727 )
...
fix broken links introduced by #16719
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-26 22:42:46 +00:00
81ef9e9e80
docs: document new feature stages ( #16719 )
...
- [x] translate notes to docs
- [x] move to Home > About > Feature Stages
- [x] decide on bullet point summaries (👍 👎 in comment)
### OOS for this PR
add support page that describes how users can get support. currently,
[this help
article](https://help.coder.com/hc/en-us/articles/25308666965783-Get-Help-with-Coder )
is the only thing that pops up and includes that `Users with valid Coder
licenses can submit tickets` but doesn't show how, nor does it include
the support bundle docs (link or content). it'd be good to have these
things relate to each other
## preview
[preview](https://coder.com/docs/@feature-stages/contributing/feature-stages )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Ben Potter <ben@coder.com >
2025-02-26 15:43:02 -05:00
Edward Angert and M Atif Ali
bebf2d5eb8
docs: update Coder version in Kubernetes doc ( #16658 )
...
closes #16570
thanks @Cjkjvfnby !
@matifali I think there is/was an automation, but I'm not sure if it's
been dropped. `kubernetes.md` has:
```md
<!-- autoversion(mainline): "--version [version]" -->
...
<!-- autoversion(stable): "--version [version]" -->
```
~additionally, I removed the `## Prerequisites` section from
`kubernetes-logs.md` because if it's only a requirement for Coder
versions earlier than 0.28.0, it's probably more confusing than useful
to the majority of readers.~
---------
Co-authored-by: M Atif Ali <atif@coder.com >
2025-02-24 10:02:12 -05:00
Edward Angert
f66a59f381
docs: highlight the tip in coder-preview section and move step ( #16597 )
...
- moves the step out of the tip and the tip into the step
- adds some context to what to do with the URL
2025-02-17 12:36:06 -05:00
Edward Angert and M Atif Ali
a5643b6f8c
docs: add doc on how to try a coder-preview build ( #16314 )
...
Co-authored-by: M Atif Ali <atif@coder.com >
2025-02-17 12:36:14 +00:00
Edward Angert and EdwardAngert
ade0a53ddb
docs: add markdown fields in webhook payloads ( #16542 )
...
These changes were made in #14931 but didn't make it into the
restructured docs
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-13 10:35:05 -05:00
Edward Angert and EdwardAngert
15d5563423
docs: update licensing steps in faq ( #16484 )
...
<details>
<summary>this would be a good candidate for an expand
component</summary>
but I don't think they work in our docs yet
</details>
[preview](https://coder.com/docs/@licensing-faq/tutorials/faqs#how-do-i-add-a-premium-trial-license )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-07 10:49:49 -05:00
Edward Angert and EdwardAngert
44d9f5ff4e
docs: comment out optional lines in values.yaml ( #16457 )
...
@michaelvp411 pointed out that some optional lines in `values.yaml`
could lead to errors if the user doesn't opt to use them. This PR
comments out those lines so that they're opt-in
[preview](https://coder.com/docs/@k8s-values-comment-opt/install/kubernetes )
(once cache catches up)
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-06 08:56:08 -05:00
Edward Angert and EdwardAngert
e289578721
docs: remove beta and closed issues from orgs doc ( #16361 )
...
## hold for release
track https://github.com/coder/coder/pull/16411
closes https://github.com/coder/internal/issues/291
[preview](https://coder.com/docs/@291-orgs-ga/admin/users/organizations )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-05 13:19:35 -05:00
Edward Angert and EdwardAngert
951a8ed98d
docs: add new licensing visibility to documentation ( #16362 )
...
closes https://github.com/coder/coder/issues/16260
[preview](https://coder.com/docs/@16260-licensing-ui/admin/licensing )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-03 11:18:44 -06:00
Edward Angert
92a490b3b6
docs: update IdP group and role sync documentation for UI configuration ( #16315 )
2025-01-31 20:39:03 +00:00
Edward Angert
3a179e9e97
docs: add a screenshot of the admin settings to doc ( #16333 )
...
add screenshot of admin settings to doc
2025-01-29 23:39:00 -05:00
Edward Angert
3897ea458b
docs: adjust steps and add screenshots for orgs ( #16248 )
...
first in a series of updates to orgs docs
2025-01-29 12:58:55 -05:00
Edward Angert
a21306e8d6
docs: add zed editor doc to workspace-access ( #16242 )
...
add zed to workspace-access docs
2025-01-24 19:37:02 +00:00
Edward Angert
0ad46d52a7
chore: update zed icon ( #16256 )
...
icon from zed.dev so we can use their official logo
2025-01-24 11:57:59 -05:00
Edward Angert and Spike Curtis
02d0650ae8
docs: add new scaling doc to best practices section ( #15904 )
...
[preview](https://coder.com/docs/@bp-scaling-coder/tutorials/best-practices/scale-coder )
---------
Co-authored-by: Spike Curtis <spike@coder.com >
2025-01-21 15:02:02 -05:00
4f438e71cf
docs: fix broken links ( #16179 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Cian Johnston <cian@coder.com >
2025-01-17 13:18:48 -05:00
Edward Angert and coryb
9fe92a9463
docs: fix workspacebuilds logs api docs ( #16062 )
...
Co-authored-by: coryb <cbennett@netflix.com >
2025-01-08 09:34:54 +05:00
ee1829ba71
docs: update external auth to better explain process ( #16027 )
...
- adds to @ChristopherJTrent's PR #15970
> Adds more information on how to add external auth, including
docker-compose and docker CLI examples and terraform code for template
integration.
- general edits and improvements to the external-auth doc
[preview](https://coder.com/docs/@15970-external-auth-update/admin/external-auth )
---------
Co-authored-by: Christopher Trent <ChristopherJTrent@outlook.com >
Co-authored-by: Muhammad Atif Ali <me@matifali.dev >
2025-01-07 15:10:16 -05:00
Edward Angert
3f1795fd92
docs: remove Coder from Quickstart title ( #16016 )
...
[preview](https://coder.com/docs/@quickstart-coder-coder/tutorials/quickstart )
2025-01-03 00:27:56 -05:00
Edward Angert and Paul Roub
761a19663f
docs: document issue with direnv and nix-shell on macOS ( #15990 ) ( #16015 )
...
- @paulroub's contribution to `CONTRIBUTING.md` adds a workaround and a
link to the direnv issue
- some editing to the format/layout of the doc
---------
Co-authored-by: Paul Roub <paul@roub.net >
2025-01-02 14:55:59 -05:00
Edward Angert
e7152d67c4
docs: add a link to the quickstart guide in the install Coder document ( #15931 )
2024-12-19 12:47:21 +05:00
Edward Angert
bcb15aab42
docs: add context for wireguard in places referencing tailscale ( #15901 )
...
> We do not use Tailscale (product) but instead import Tailscale OSS
libraries which has some nice ways of handling Wireguard. We also use
Tailscale's logo in our architecture, but calling it only `Tailscale`
seems to throw people off when they're considering Coder and how it
works.
I've left it wherever it seems to make sense (such as when we talk about
[DERP](https://coder.com/docs/admin/networking#relayed-connections )),
and sprinkled some `Wireguard` and `websocket/HTTPS` where I could
2024-12-17 15:13:12 -05:00
Edward Angert and EdwardAngert
1eba4c08cb
docs: add beta back to orgs ( #15902 )
...
I merged https://github.com/coder/coder/pull/15888/ too early.
This PR incorporates @matifali 's edit suggestions
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 13:37:26 -05:00
21cc6f77fe
docs: move premium and enterprise badges from heading to info in admonition ( #15774 )
...
closes https://github.com/coder/coder.com/issues/666
[preview](https://coder.com/docs/@666-unheading-premium/user-guides/workspace-scheduling#autostop-requirement )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 18:20:01 +00:00
Edward Angert and EdwardAngert
468ffd9919
docs: copy edit the organizations doc and add link to best practices ( #15888 )
...
[preview](https://coder.com/docs/@orgs-edit-202412/admin/users/organizations )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 10:44:21 +05:00
74f07ec9ae
docs: add new security doc to best practices section ( #15805 )
...
[preview](https://coder.com/docs/@bp-security/tutorials/best-practices/security-best-practices )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Spike Curtis <spike@coder.com >
2024-12-16 20:47:38 +00:00
29c9bbf2bb
docs: add new organizations docs to best practices section ( #15732 )
...
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-11 16:32:21 -05:00
5e7199233c
docs: add cli steps for org sync ( #15673 )
...
[preview](https://coder.com/docs/@15431-docs-org-sync/admin/users/idp-sync#organization-sync-premium )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-10 11:09:41 -05:00
b06d833012
docs: improve dev containers documentation for user start-up ( #15458 )
...
- [x] TODO: verify and expand [What is an image, template, devcontainer,
or
workspace](https://coder.com/docs/@bp-dev-containers/admin#what-is-an-image-template-devcontainer-or-workspace )
- [x] TODO: verify and expand `## Add a devcontainer template to Coder`
- [x] TODO: verify and expand `## Layer and image caching`
- [x] TODO: link to and edit
[dotfiles](https://coder.com/docs/user-guides/workspace-dotfiles ) doc
- [x] TODO:
https://github.com/coder/coder/pull/15458/files#diff-be0dd9ff983020129c7a94c628a0fc4a397a9bbc8b5eec92ec38f4b8c83fe167R10
[preview](https://coder.com/docs/@bp-dev-containers/admin/templates/managing-templates/devcontainers )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Cian Johnston <cian@coder.com >
Co-authored-by: Ben Potter <ben@coder.com >
Co-authored-by: Edward Angert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
2024-12-02 09:19:04 -08:00
Edward Angert and EdwardAngert
684e75e2a7
docs: create a markdown code snippet file to make it easier for contributors ( #15611 )
...
adds snippets to make some of the docs markdown components a little
easier to use
- wraps selected text where it seems appropriate
- limits code block languages (these are suggestions, you can choose
from the list or enter anything)
tabs example:
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-21 22:09:56 +00:00
Edward Angert and EdwardAngert
56e219b50d
docs: update template-from-scratch ( #15101 )
...
closes https://github.com/coder/internal/issues/104
- [x] update screenshots
- [x] consistent md
- [x] confirm and update `Dockerfile` and `main.tf`
- matched up to the Docker Containers starter template
- upload template
- [x] confirm CLI steps
- [x] add steps in tab for Dashboard
- [x] ~confirm that the expand works~ it doesn't
<https://coder.com/docs/@template-from-scratch-update/tutorials/template-from-scratch >
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-12 14:01:51 -05:00
Edward Angert and EdwardAngert
eff07a2db0
docs: clarify admin email telemetry ( #15485 )
...
add a note to the telemtery doc that explains that we do collect the
admin email
https://coder.com/docs/@telemetry-clarification/admin/setup/telemetry#what-we-collect
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-12 11:24:13 -05:00
Edward Angert and EdwardAngert
50e95ba676
docs: adjust manual github action screenshot in contributing.md ( #15439 )
...
resolves #15407
adjust manual github action screenshot in contributing.md
[preview](https://coder.com/docs/@15407-contrib-image/CONTRIBUTING#deploying-a-pr )
(once ready)
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-08 13:15:57 -05:00
Edward Angert and EdwardAngert
f7694568eb
docs: add workplace scheduling to manifest ( #15384 )
...
- [ ] check links to
<https://coder.com/docs/@workspace-scheduling/admin/templates/managing-templates/schedule#dormancy-threshold-enterprise-premium >
- @mattvollmer reports that
<https://coder.com/docs/templates/managing-templates/schedule#dormancy-threshold-enterprise >
is missing. I'll try to find refs to it
[preview](https://coder.com/docs/@workspace-scheduling/admin/templates/managing-templates/schedule )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-08 00:54:52 -05:00
Edward Angert and EdwardAngert
e688ff723b
docs: add deploy id to license doc ( #15415 )
...
resolves #15414
adds a section to licensing doc to show where to find the deployment ID
[preview](https://coder.com/docs/@15414-deploy-id/admin/licensing#find-your-deployment-id )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-07 21:54:11 -08:00
Edward Angert and EdwardAngert
0961468398
fix: add root-level code of conduct link ( #15386 )
...
closes #15369
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-05 17:15:26 -05:00
Edward Angert and EdwardAngert
62fa7e5ab8
docs: disable markdown link check on mailto links ( #15382 )
...
to satisfy CI
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-05 12:35:46 -05:00
Edward Angert and EdwardAngert
1f93b80e09
chore: fix docs/admin links and upgrade notice ( #15043 )
...
- Update links to /docs/admin to match the new structure
- TODO: remove the release string from the "upgrade available"
instructions link
- [x]
https://github.com/coder/coder/blob/update-upgrade-config-links/cli/server.go#L646
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-01 19:43:51 +00:00
18ef954a03
docs: add new best practice doc to speed up templates and workspaces ( #15296 )
...
closes https://github.com/coder/coder/issues/14858
- [x] TODO: update `build-timeline.png`
- [x] TODO: `Best practices` doesn't show up in the sidebar until you're
actually in the doc 🤔
[preview](https://coder.com/docs/@bp-speed-up-templates/tutorials/best-practices/speed-up-templates )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
Co-authored-by: Ben Potter <ben@coder.com >
2024-11-01 11:24:35 -05:00
Edward Angert and EdwardAngert
007f0a35a4
fix: adjust instances of Github to GitHub ( #15203 )
...
s/Github/GitHub
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-28 07:43:30 -04:00
Edward Angert and EdwardAngert
0fba291ffe
docs: add date to Quickstart guide ( #15199 )
...
and try to trick the CI into passing + building the page 😬
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 12:56:17 -05:00
ed5da65a54
chore(docs): add Quickstart doc to tutorials ( #14744 )
...
New doc to get users up and running quickly
preview: https://coder.com/docs/@quickstart-guide/tutorials/quickstart
## To Do
- [x] update or remove Codium steps
- [x] add to sidebar
- [x] add to README and others as needed
- [x] reference https://github.com/coder/coder/pull/11946 and the
discussion to influence this PR
closes https://github.com/coder/internal/issues/107
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
2024-10-23 11:31:29 -04:00
Edward Angert and EdwardAngert
d7baa49d6d
docs: add primary to wsproxy ls ( #15185 )
...
Add primary to `coder wsproxy ls` results in
<https://coder.com/docs/admin/networking/workspace-proxies#step-2-deploy-the-proxy >
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 11:15:55 -04:00
