docs: Describe support links (coder#6353)

mtojek · web-flow · commit ec6f78d09ee1 · 2023-02-27T15:33:34.000+01:00
* docs: Describe support links

* Fix: size

* Address PR comments
diff --git a/docs/admin/support-links.md b/docs/admin/support-links.md
@@ -0,0 +1,28 @@
+# Support Links
+
+Support links let admins adjust the user dropdown menu to include links referring to internal company resources. The menu section replaces the original menu positions: documentation, report a bug to GitHub, or join the Discord server.
+
+![support links](../images/admin/support-links.png)
+
+Custom links can be set in the deployment configuration using the `server.yaml` file:
+
+```yaml
+support:
+  links:
+    - name: "On-call 🔥"
+      target: "http://on-call.example.internal"
+      icon: "bug"
+    - name: "😉 Getting started with Go!"
+      target: "https://go.dev/"
+    - name: "Community"
+      target: "https://github.com/coder/coder"
+      icon: "chat"
+```
+
+## Icons
+
+The link icons are optional, and limited to: `bug`, `chat`, and `docs`.
+
+## Up next
+
+- [Enterprise](../enterprise.md)
diff --git a/docs/enterprise.md b/docs/enterprise.md
@@ -16,6 +16,7 @@ trial](https://coder.com/trial).
 | Deployment      | [High Availability](./admin/high-availability.md)                           |     ❌      |     ✅     |
 | Deployment      | [Service Banners](./admin/service-banners.md)                               |     ❌      |     ✅     |
 | Deployment      | Isolated Terraform Runners                                                  |     ❌      |     ✅     |
+| Deployment      | [Support links](./admin/support-links.md)                                   |     ❌      |     ✅     |
 
 > Previous plans to restrict OIDC and Git Auth features in OSS have been removed
 > as of 2023-01-11
diff --git a/docs/images/admin/support-links.png b/docs/images/admin/support-links.png
diff --git a/docs/images/icons/link.svg b/docs/images/icons/link.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="48" viewBox="0 96 960 960" width="48"><path d="M450 776H280q-83 0-141.5-58.5T80 576q0-83 58.5-141.5T280 376h170v60H280q-58.333 0-99.167 40.765-40.833 40.764-40.833 99Q140 634 180.833 675q40.834 41 99.167 41h170v60ZM325 606v-60h310v60H325Zm185 170v-60h170q58.333 0 99.167-40.765 40.833-40.764 40.833-99Q820 518 779.167 477 738.333 436 680 436H510v-60h170q83 0 141.5 58.5T880 576q0 83-58.5 141.5T680 776H510Z"/></svg>
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -298,6 +298,13 @@
           "description": "Learn what usage telemetry Coder collects",
           "path": "./admin/telemetry.md",
           "icon_path": "./images/icons/science.svg"
+        },
+        {
+          "title": "Support Links",
+          "description": "Learn how to configure Support Links",
+          "path": "./admin/support-links.md",
+          "icon_path": "./images/icons/link.svg",
+          "state": "enterprise"
         }
       ]
     },

Original file line number	Diff line number	Diff line change
`@@ -298,6 +298,13 @@`
`298`	`298`	`"description": "Learn what usage telemetry Coder collects",`
`299`	`299`	`"path": "./admin/telemetry.md",`
`300`	`300`	`"icon_path": "./images/icons/science.svg"`
	`301`	`+ },`
	`302`	`+ {`
	`303`	`+ "title": "Support Links",`
	`304`	`+ "description": "Learn how to configure Support Links",`
	`305`	`+ "path": "./admin/support-links.md",`
	`306`	`+ "icon_path": "./images/icons/link.svg",`
	`307`	`+ "state": "enterprise"`
`301`	`308`	`}`
`302`	`309`	`]`
`303`	`310`	`},`