diff --git a/docs/admin/support-links.md b/docs/admin/support-links.md new file mode 100644 index 0000000000000..ad32a9b165fc4 --- /dev/null +++ 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 index 88fb8bf31a397..3f7263a8b2564 100644 --- 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 new file mode 100644 index 0000000000000..5b0f431d00a75 Binary files /dev/null and b/docs/images/admin/support-links.png differ diff --git a/docs/images/icons/link.svg b/docs/images/icons/link.svg new file mode 100644 index 0000000000000..fac13a1361f13 --- /dev/null +++ b/docs/images/icons/link.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/manifest.json b/docs/manifest.json index e81f793b7fba5..78d9903fd1ce6 100644 --- 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" } ] },