From 6520a51766fcfdbe9647d276ca808c790938b7c6 Mon Sep 17 00:00:00 2001
From: Joe Previte <jjprevite@gmail.com>
Date: Mon, 19 Sep 2022 20:42:34 +0000
Subject: [PATCH] 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.
---
 docs/admin/open-in-coder.md | 29 +++++++++++++++++++++++++++++
 docs/manifest.json          |  5 +++++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/admin/open-in-coder.md

diff --git a/docs/admin/open-in-coder.md b/docs/admin/open-in-coder.md
new file mode 100644
index 0000000000..c19efb1d96
--- /dev/null
+++ b/docs/admin/open-in-coder.md
@@ -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
diff --git a/docs/manifest.json b/docs/manifest.json
index a0aa731d77..59678ea5b7 100644
--- a/docs/manifest.json
+++ b/docs/manifest.json
@@ -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"
         }
       ]
     },