Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: Describe support links #6353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/admin/support-links.md
Original file line number Diff line number Diff line change
@@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this context, we should probably show the default support links.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!


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)
1 change: 1 addition & 0 deletions docs/enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file added docs/images/admin/support-links.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/icons/link.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
},
Expand Down