diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md new file mode 100644 index 0000000000..5d061b3bb1 --- /dev/null +++ b/docs/admin/appearance.md @@ -0,0 +1,39 @@ +# Appearance + +## 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 `-c ` +flag to `coder server`. + +```yaml +supportLinks: + - 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`. + +## Service Banners (enterprise) + +Service Banners let admins post important messages to all site users. Only Site Owners may set the service banner. + +![service banners](../images/admin/service-banners.png) + +You can access the Service Banner settings by navigating to +`Deployment > Service Banners`. + +## Up next + +- [Enterprise](../enterprise.md) diff --git a/docs/admin/service-banners.md b/docs/admin/service-banners.md deleted file mode 100644 index 95e49602b2..0000000000 --- a/docs/admin/service-banners.md +++ /dev/null @@ -1,12 +0,0 @@ -# Service Banners - -Service Banners let admins post important messages to all site users. Only Site Owners may set the service banner. - -![service banners](../images/admin/service-banners.png) - -You can access the Service Banner settings by navigating to -`Deployment > Service Banners`. - -## Up next - -- [Enterprise](../enterprise.md) diff --git a/docs/enterprise.md b/docs/enterprise.md index e990fd15a0..d24d375b9d 100644 --- a/docs/enterprise.md +++ b/docs/enterprise.md @@ -14,7 +14,7 @@ trial](https://coder.com/trial). | Cost Control | [Quotas](./admin/quotas.md) | ❌ | ✅ | | Cost Control | [Max Workspace Autostop](./templates/README.md#configure-max-workspace-autostop) | ❌ | ✅ | | Deployment | [High Availability](./admin/high-availability.md) | ❌ | ✅ | -| Deployment | [Service Banners](./admin/service-banners.md) | ❌ | ✅ | +| Deployment | [Appearance](./admin/appearance.md) | ❌ | ✅ | | Deployment | Isolated Terraform Runners | ❌ | ✅ | > Previous plans to restrict OIDC and Git Auth features in OSS have been removed diff --git a/docs/images/admin/support-links.png b/docs/images/admin/support-links.png new file mode 100644 index 0000000000..e80f6afcca Binary files /dev/null and b/docs/images/admin/support-links.png differ diff --git a/docs/manifest.json b/docs/manifest.json index 64a96fa336..4c4fb7d187 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -335,9 +335,9 @@ "icon_path": "./images/icons/speed.svg" }, { - "title": "Service Banners", - "description": "Learn how to configure Service Banners", - "path": "./admin/service-banners.md", + "title": "Appearance", + "description": "Learn how to configure the appearance of Coder", + "path": "./admin/appearance.md", "icon_path": "./images/icons/info.svg", "state": "enterprise" },