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
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
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
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
92a490b3b6
docs: update IdP group and role sync documentation for UI configuration ( #16315 )
2025-01-31 20:39:03 +00:00
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
3043e79a28
chore: fix template-from-scratch.md ( #16041 )
...
Added the missing line to make the code snippet work
2025-01-06 12:06:31 +11: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
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
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
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
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
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
111029ec07
chore: clarify template provisioning speed doc ( #15383 )
...
I noticed a few inaccuracies in this doc, or aspects which could've been
explained a little more. In other cases, I've added some specificity in
service of clarity.
---------
Signed-off-by: Danny Kopping <danny@coder.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-08 16:06:20 +00:00
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
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
971388762c
chore(docs): change mentions of enterprise to premium ( #15258 )
...
Matches our latest licensing verbiage.
2024-10-28 15:56:51 -05:00
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
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
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
ab6cb1a787
docs: fix links for revere-proxy docs ( #15026 )
2024-10-10 05:31:19 +00:00
999ae7ba56
chore(docs): fix broken links and update file paths ( #14990 )
2024-10-05 18:08:50 +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
