mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
764600003b
* docs: add open in coder
This adds new documentation for the "Open in Coder" button that admins
can use to get their developers up and running faster.
* fix: display error if template not found
Previously, we weren't handling a case where we tried to get a template
that returned a 404 from the backend.
Now we handle that case in our state machine and display the error
message from the API on the frontend.
* feat: support template query param in index
This adds support to navigate directly to a template from the index by
using the `?template=<name>` query param.
* Revert "feat: support template query param in index"
This reverts commit bad7ffb677.
We decided to use the `/template/path` route instead.
* fixup!: docs: add open in coder
* docs: add open in coder to dogfood readme
* Update docs/admin/open-in-coder.md
Co-authored-by: Ben Potter <ben@coder.com>
* Update docs/admin/open-in-coder.md
Co-authored-by: Ben Potter <ben@coder.com>
* Update docs/admin/open-in-coder.md
Co-authored-by: Ben Potter <ben@coder.com>
28 lines
862 B
Markdown
28 lines
862 B
Markdown
# Open in Coder Button
|
|
|
|
Add a Markdown button to your project's `README.md` to get your developers up and running with Coder with a few clicks.
|
|
|
|
A basic example looks like this:
|
|
|
|
```markdown
|
|
[](https://<deployment-url>/templates/<template-name>)
|
|
```
|
|
|
|
which renders like this:
|
|
|
|
|
|
|
|
You can customize this to take developers directly to your team's template. Read on to learn more.
|
|
|
|
### Customization
|
|
|
|
The underlying link for this button consists of the following pieces:
|
|
- <deployment-url>: where your Coder deployment lives i.e. https://dev.coder.com
|
|
- <template-name>: name of template i.e. coder
|
|
|
|
### template name
|
|
|
|
A template to redirect your developers to after they authenticate on your deployment.
|
|
|
|
Example: https://dev.coder.com/templates/coder
|