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.
This commit is contained in:
Joe Previte
2022-09-20 20:27:31 +00:00
parent 5e2efb68f1
commit 6520a51766
2 changed files with 34 additions and 0 deletions
+29
View File
@@ -0,0 +1,29 @@
# 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:
```text
[![Open in Coder](https://cdn.coder.com/embed-button.svg)](https://dev.coder.com/?template=coder-ts)
```
which renders like this:
![Open in Coder](https://cdn.coder.com/embed-button.svg)
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
- <query-params>: optional query parameters to customize the experience
These are the following query parameters we support:
### template
A template to redirect your developers to after they authenticate on your deployment.
Example: https://dev.coder.com/?template=coder-ts
+5
View File
@@ -188,6 +188,11 @@
"title": "Enterprise",
"description": "Learn how to enable Enterprise features.",
"path": "./admin/enterprise.md"
},
{
"title": "Open in Coder Button",
"description": "Learn how to create an 'Open in Coder' button.",
"path": "./admin/open-in-coder.md"
}
]
},