Skip to content

docs: mention /icons in the template documentation #10230

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.

Sign up for GitHub

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 6 commits into from
Oct 12, 2023
Merged

docs: mention /icons in the template documentation #10230

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
59b88cf
docs: mention /icons
aslilac Oct 11, 2023
34da7eb
add an image
aslilac Oct 11, 2023
2de4355
bundled
aslilac Oct 12, 2023
dc0c569
incorporate some suggestions
aslilac Oct 12, 2023
1b7cd8d
add an `option`, for fun
aslilac Oct 12, 2023
574d302
add some thoughts about external icons
aslilac Oct 12, 2023
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
Prev Previous commit
Next Next commit
incorporate some suggestions
  • Loading branch information
@aslilac
aslilac committed Oct 12, 2023
commit dc0c569ecb427fe939561120f24c0081b1312737
29 changes: 28 additions & 1 deletion docs/templates/icons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,34 @@
Coder uses icons in several places, including ones that can be configured
throughout the app, or specified in your Terraform. They're specified by a URL,
which can be to an image hosted on a CDN of your own, or one of the icons that
come included with your Coder deployment.
come bundled with your Coder deployment.

- **Template Icons**:

- Make templates and workspaces visually recognizable with a relevant or
memorable icon

- [**Terraform**](https://registry.terraform.io/providers/coder/coder/latest/docs):

- [`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app#icon)
- [`coder_parameter`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/parameter#icon)
and
[`option`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/parameter#nested-schema-for-option)
blocks
- [`coder_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script#icon)

These can all be configured to use an icon by setting the `icon` field.

```terraform
data "coder_parameter" "my_parameter" {
icon = "/icon/coder.svg"
...
}
```

- [**Authentication Providers**](https://coder.com/docs/v2/latest/admin/external-auth):

- Use icons for external authentication providers to make them recognizable

## Bundled icons

Expand Down