0cac6a8c38
docs: add provisioner job state transition diagram ( #17882 )
...
# Description
Add a state transition diagram for provisioner jobs to the
documentation.
This PR introduces a new diagram illustrating the lifecycle and state
transitions of provisioner jobs. The diagram complements the existing
status table by providing a visual representation of how jobs move
between different states throughout their lifecycle.
# Changes
- Added a SVG diagram under the **Manage Provisioner Jobs**
documentation page, in the **Provisioner Job Status** section.
- Included a brief introductory text before the diagram.
Mermaid
[link](https://www.mermaidchart.com/play#pako:eNqFkD1PwzAQhv_KyRMdvPSDIUKVUFIGJtSyYQbXvjSW3DM4jiqE-O_YsRtFCMF49z6P75U_mXIaWcU454KUo9acKkEAocMzVkA4BC-toDFvrbuoTvoAz02CAO5vXgQ7hLgS7HUBnMOjO0LtUQbUcdxCHYEnJG3oFJFs1VdwNAvYRHA_EM3BZnrRnd8sRvTu6LeHQSns-3aw9mNUaZlapC1q1P_YFxM62HnvfHZX0X2Qxv4qSlJorQzGUXL3-D5gf21M66hmZF6a1kn_qeYT5eRf4FQ2s5vpxqwgbXJ4m75_RylYlGRVkjIup5F9fQNTV5aS )
---
Screenshot of `Provisioner job status` section in documentation page:
2025-05-19 17:23:36 -04:00
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
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
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
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
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
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
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
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
a61c3e7a1c
docs: add tutorials for using early access AI agent features ( #17186 )
...
Some content is still being merged, but the structure is still there
Preview: https://coder.com/docs/@ai-features/tutorials/ai-agents
2025-04-01 19:57:05 -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
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
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
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
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
6acc3a9469
docs: update the quickstart page ( #16666 )
...
## Changes
1. Update the `0.0.0.0:3001` web UI address to `localhost:3000`. Coder
starts on port 3000 by default. It'd use 3001 only if 3000 was already
taken.
2. Update the screenshot of the `/setup` page to reflect how it will
look like after merging https://github.com/coder/coder/pull/16662 . Note:
this PR should be merged only after the other one is.
3. Minor phrasing changes.
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-25 16:32:20 +01:00
dd6d57ed39
feat: add docs explaining how Coder integrates with PlatformX ( #16378 )
...
More details in https://github.com/coder/coder-platformx-notifications
Preview at
https://coder.com/docs/@dx-integration/admin/integrations/platformx (may
be slightly outdated due to caching)
closes https://github.com/coder/coder/issues/16308
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-02-03 18:06:30 -06:00
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
92a490b3b6
docs: update IdP group and role sync documentation for UI configuration ( #16315 )
2025-01-31 20:39:03 +00:00
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
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
a21306e8d6
docs: add zed editor doc to workspace-access ( #16242 )
...
add zed to workspace-access docs
2025-01-24 19:37:02 +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
a9195bfe74
docs: add Amazon DCV Windows module to guides ( #15610 )
2024-11-26 21:41:22 +05:00
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
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
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
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
25738388d5
chore(docs): add documentation on custom roles ( #15280 )
...
These docs were overwritten in the restructure merge.
2024-10-29 20:58:26 -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
20a9e9bdfb
chore(docs): remove workspace proxy map ( #15070 )
...
remove workspace proxy map
- replace later with another image or diagram
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 11:15:32 -04: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
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
d04eaf8392
docs: add organizations, provisioners, and premium license docs ( #14778 )
...
- [x] Mention Orgs is beta and add a link to get feedback
- [x] Add docs on new provisioner authentication architecture and
deprecate the old one
- [x] Add/update docs for IdP sync
- [x] Organization Sync
- [x] Group Sync
- [x] Role Sync
- [x] Modify `coder.com` codebase to add `Premium` and `Beta` pill, and
allow multiple pills: https://github.com/coder/coder.com/pull/638
- [x] Replace all mentions of "Enterprise" with "Premium" in docs
- [x] edit: change it to "Licensing"
- [x] Remove the enterprise page and change all links to
coder.com/pricing
- [x] Merge #14786
- [x] Add redirects for coder.com to redirect the `using-organizations`
guide to the new orgs one and /enterprise to /premium
https://github.com/coder/coder.com/pull/645
- [x] Custom roles
- [x] https://github.com/coder/coder/pull/14786
- [x] Remove all mentions of orgs experiment
- [x] Update in-product copy & links to link to the new docs pages
Anything I am missing?
---
[Preview
this](https://coder.com/docs/@orgs-licenses/admin/organizations )
---------
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Jaayden Halko <jaayden.halko@gmail.com >
2024-10-01 12:34:16 -05:00
1b5f3418d3
chore: align active version terminology and link to docs ( #14639 )
2024-09-11 12:25:07 +02:00
c1bb5abcb7
docs: add new marketecture ( #14567 )
2024-09-05 08:16:59 -04:00
66c8060605
Minor fixups, added troubleshooting ( #14519 )
2024-09-02 16:10:54 +02:00
043f4f5327
docs: add documentation for notifications feature ( #14478 )
2024-08-30 17:30:06 +02:00
c3ef7dc33b
docs: add organizations guide ( #14012 )
...
* wip
* add workspace & members screenshot
* add audit logs
* org id and provisioner key
* Update docs/guides/using-organizations.md
Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com >
* edits to docs
* fixup
* fmt
* changes based on kirby feedback
* fix link
* fix manifest
* fmt
---------
Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com >
2024-08-19 15:11:36 +00:00
238e9956f4
docs: add vs code extensions documentation ( #14119 )
...
* docs: add vs code extensions documentation
* clarify msft marketplace connection
* `make fmt`
* fix links
* rm image
---------
Co-authored-by: Muhammad Atif Ali <me@matifali.dev >
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
2024-08-08 10:52:46 -04:00
d8d86b16dc
docs: move architecture to top level ( #13722 )
2024-07-01 11:58:56 -04:00
808e1c0d89
docs: add screenshots page ( #13582 )
...
* docs: add screenshots page
* fmt
2024-06-15 15:34:18 -05:00
213848e2e3
chore(docs): rename banners and show usage of multiple ( #13435 )
...
* renamed banners in docs
* fmt
* Update appearance.md
Co-authored-by: Kayla Washburn-Love <mckayla@hey.com >
* fmt
---------
Co-authored-by: Kayla Washburn-Love <mckayla@hey.com >
Co-authored-by: Ben <me@bpmct.net >
2024-06-04 17:49:13 +00:00
7cc96f5d40
chore(docs): add recommendations for dependency management ( #13400 )
2024-05-30 10:17:26 +01:00
679099373b
docs(ides): document connection via JetBrains Fleet ( #13179 )
...
* docs: add docs to connect via JetBrains Fleet
* Create fleet.md
* Update fleet.md
* Create ssh-connect-to-coder.png
* Add files via upload
* `make fmt`
* Update fleet.md
* Update docs/ides/fleet.md
Co-authored-by: Kyle Carberry <kyle@coder.com >
* Update fleet.md
---------
Co-authored-by: Kyle Carberry <kyle@coder.com >
2024-05-09 21:29:53 +03:00
a3c23ed313
chore: add docs for sharing ports ( #13136 )
...
Co-authored-by: kirby <kirby@coder.com >
Co-authored-by: Stephen Kirby <me@skirby.dev >
2024-05-03 12:38:29 -04:00
28754a79e5
docs: describe air-gapped architecture ( #12897 )
2024-04-09 12:33:06 +02:00
