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
8914f7a95b
chore: improve prebuilds docs ( #17850 )
...
These items came up in an internal "bug bash" session yesterday.
@EdwardAngert note: I've reverted to the "transparent" phrasing; the
current docs confused a couple folks yesterday, and I feel that
"transparent" is clearly understood in this context.
---------
Signed-off-by: Danny Kopping <dannykopping@gmail.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-05-16 19:25:09 +02:00
6e967780c9
feat: track resource replacements when claiming a prebuilt workspace ( #17571 )
...
Closes https://github.com/coder/internal/issues/369
We can't know whether a replacement (i.e. drift of terraform state
leading to a resource needing to be deleted/recreated) will take place
apriori; we can only detect it at `plan` time, because the provider
decides whether a resource must be replaced and it cannot be inferred
through static analysis of the template.
**This is likely to be the most common gotcha with using prebuilds,
since it requires a slight template modification to use prebuilds
effectively**, so let's head this off before it's an issue for
customers.
Drift details will now be logged in the workspace build logs:
Plus a notification will be sent to template admins when this situation
arises:
A new metric - `coderd_prebuilt_workspaces_resource_replacements_total`
- will also increment each time a workspace encounters replacements.
We only track _that_ a resource replacement occurred, not how many. Just
one is enough to ruin a prebuild, but we can't know apriori which
replacement would cause this.
For example, say we have 2 replacements: a `docker_container` and a
`null_resource`; we don't know which one might
cause an issue (or indeed if either would), so we just track the
replacement.
---------
Signed-off-by: Danny Kopping <dannykopping@gmail.com >
2025-05-14 14:52:22 +02:00
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
58adc629fa
chore: add prebuild docs ( #17580 )
...
Partially addresses https://github.com/coder/internal/issues/593
2025-05-09 07:26:35 +00:00
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
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
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
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
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
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
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
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
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
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
db064ed0f8
docs: fix formatting of note callouts ( #16761 )
...
Fixes the formatting of several note callouts. Previously, these would render incorrectly both on GitHub and on the documentation site.
2025-03-07 10:35:14 -05:00
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
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
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
fc2815cfdb
docs: fix anchor and repo links ( #16555 )
2025-03-02 09:55:36 -06:00
d52d2397ea
docs: fix link to CODER_QUIET_HOURS_DEFAULT_SCHEDULE in schedule doc ( #16545 )
...
Corrects incorrect reference to env variable
`CODER_DEFAULT_QUIET_HOURS_SCHEDULE`. Changes to
`CODER_QUIET_HOURS_DEFAULT_SCHEDULE`. Also hyperlinks to the server flag
(similar to `CODER_ALLOW_CUSTOM_QUIET_HOURS`)
2025-02-12 16:16:42 -05:00
1aee589095
docs(admin/templates/): fix terraform provider links ( #16338 )
2025-01-30 09:08:59 +00:00
76adde91dc
fix(provisioner/terraform/tfparse): allow empty values in coder_workspace_tag defaults ( #16303 )
...
* chore(docs): update docs re workspace tag default values
* chore(coderdenttest): use random name instead of t.Name() in newExternalProvisionerDaemon
* fix(provisioner/terraform/tfparse): allow empty values in coder_workspace_tag defaults
2025-01-28 09:11:39 +00:00
94f5d52fdc
chore: adopt markdownlint and markdown-table-formatter for *.md ( #15831 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-01-03 13:12:59 +00:00
7be96bbb09
chore(docs): clarify that variables be edited through the web UI ( #15799 )
2024-12-18 15:55:19 +00: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
069655ace9
chore: unify template naming ( #15757 )
...
This PR changes template names and docs to follow the
`<provider>-<os/whatever>` format for all templates.
I've decided not to split this into multiple PRs because I'd have to
edit rebase the other PRs once one of them gets merged, this should be
relatively low-impact anyways.
This aligns with our goals to make templates more user-friendly.
Closes #15754
2024-12-05 22:37:25 +05:00
3b1131ca01
fix(docs): fix a typo in extending-templates ( #15744 )
...
It's -> its
2024-12-04 10:17:39 -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
e550365e35
chore(docs): update documentation for coder_workspace_tags ( #15620 )
...
Adds documentation relating to
https://github.com/coder/coder/issues/15087 and
https://github.com/coder/coder/issues/15427
See also: https://github.com/coder/coder/pull/15578
2024-11-25 21:01:18 +00:00
dcbcf6740c
docs: add guide for CI/CD template testing ( #15528 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-11-20 23:58:51 +05:00
55dccae5a3
chore(docs): document how to correctly override list(string) parameters ( #15497 )
...
- Adds documentation for how to correctly hold --parameter with list(string)
- Adds tests for the aforementioned documented correct finger positions for --parameter list(string)
2024-11-13 15:41:36 +00:00
6ff302b740
docs: add Docker to provider authentication docs ( #15494 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-11-13 15:40:41 +00:00
fa69d1ca74
ci: reenable link checker & fix broken links ( #15489 )
...
Follow-up on #15484 .
2024-11-13 16:04:10 +11:00
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
399c830b51
chore(docs): add info on new build timings in docs ( #15310 )
...
Adds information on workspace build timings in workspace lifecycle and
template troubleshooting docs.
2024-11-01 12:17:50 -05:00
971388762c
chore(docs): change mentions of enterprise to premium ( #15258 )
...
Matches our latest licensing verbiage.
2024-10-28 15:56:51 -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
02f6203dc7
chore(cli): rename build options to ephemeral parameters in cli ( #15030 )
...
This PR aims to rename `build-option` to `ephemeral-parameters` based on
#10488 conversation.
`build-option` has been renamed `ephemeral-parameter` and can be used to
define a value for an ephemeral parameter in the template.
`build-options` has been renamed `prompt-ephemeral-parameters` and can
be used to prompt the user to put values for the ephemeral parameters in
the template.
---------
Co-authored-by: Mathias Fredriksson <mafredri@gmail.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: defelmnq <yvincent@coder.com >
2024-10-16 23:54:12 +02:00
29763b1b4c
chore(docs): add notes regarding provisioner tags and untagged jobs ( #15081 )
...
Relates to https://github.com/coder/coder/issues/15047
---------
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-10-16 09:22:39 +01:00
75b5d71216
fix(docs): fix a typo in the devcontainer documentation ( #15102 )
...
This PR fixes a minor typo in our documentation:
https://coder.com/docs/admin/templates/managing-templates/devcontainers
2024-10-16 10:05:31 +02:00
89ff48744c
chore(docs): fix broken or missing links ( #15085 )
...
Fixes a number of TODOs and broken links.
2024-10-15 16:50:49 +01:00
9eefd2a636
chore(docs): correct broken links in restructure ( #14989 )
...
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
2024-10-05 17:44:02 +00:00
419eba5fb6
docs: restructure docs ( #14421 )
...
Closes #13434
Supersedes #14182
---------
Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com >
Co-authored-by: Ethan Dickson <ethan@coder.com >
Co-authored-by: Ben Potter <ben@coder.com >
Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com >
Co-authored-by: Stephen Kirby <me@skirby.dev >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-10-05 10:52:04 -05:00
Edward Angert