docs: add open in coder

jsjoeio · jsjoeio · commit 6d3f2cf8b5c0 · 2022-09-20T20:24:25.000Z
This adds new documentation for the "Open in Coder" button that admins
can use to get their developers up and running faster.
diff --git a/docs/admin/open-in-coder.md 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
@@ -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"
         }
       ]
     },
diff --git a/site/src/pages/index.tsx b/site/src/pages/index.tsx
@@ -1,6 +1,13 @@
 import { FC } from "react"
-import { Navigate } from "react-router-dom"
+import { Navigate, useSearchParams } from "react-router-dom"
 
 export const IndexPage: FC = () => {
+  const [searchParams, _] = useSearchParams()
+  const template = searchParams.get("template")
+
+  if (template) {
+    return <Navigate to={`/templates/${template}`} replace />
+  }
+
   return <Navigate to="/workspaces" replace />
 }

Original file line number	Diff line number	Diff line change
`@@ -188,6 +188,11 @@`
`188`	`188`	`"title": "Enterprise",`
`189`	`189`	`"description": "Learn how to enable Enterprise features.",`
`190`	`190`	`"path": "./admin/enterprise.md"`
	`191`	`+ },`
	`192`	`+ {`
	`193`	`+ "title": "Open in Coder Button",`
	`194`	`+ "description": "Learn how to create an 'Open in Coder' button.",`
	`195`	`+ "path": "./admin/open-in-coder.md"`
`191`	`196`	`}`
`192`	`197`	`]`
`193`	`198`	`},`