docs: Describe support links (#6353)

* docs: Describe support links

* Fix: size

* Address PR comments
This commit is contained in:
Marcin Tojek
2023-02-27 15:33:34 +01:00
committed by GitHub
parent 2e53fb55da
commit ec6f78d09e
5 changed files with 37 additions and 0 deletions

View File

@ -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)

View File

@ -16,6 +16,7 @@ trial](https://coder.com/trial).
| Deployment | [High Availability](./admin/high-availability.md) | ❌ | ✅ | | Deployment | [High Availability](./admin/high-availability.md) | ❌ | ✅ |
| Deployment | [Service Banners](./admin/service-banners.md) | ❌ | ✅ | | Deployment | [Service Banners](./admin/service-banners.md) | ❌ | ✅ |
| Deployment | Isolated Terraform Runners | ❌ | ✅ | | 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 > Previous plans to restrict OIDC and Git Auth features in OSS have been removed
> as of 2023-01-11 > as of 2023-01-11

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

View File

@ -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>

After

Width:  |  Height:  |  Size: 463 B

View File

@ -298,6 +298,13 @@
"description": "Learn what usage telemetry Coder collects", "description": "Learn what usage telemetry Coder collects",
"path": "./admin/telemetry.md", "path": "./admin/telemetry.md",
"icon_path": "./images/icons/science.svg" "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"
} }
] ]
}, },