- Notifications
You must be signed in to change notification settings - Fork928
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Binary file addeddocs/images/icons-gallery.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletionsdocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletionsdocs/templates/icons.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Icons | ||
| --- | ||
| 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 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" | ||
| option { | ||
| icon = "/emojis/1f3f3-fe0f-200d-26a7-fe0f.png" | ||
| } | ||
| } | ||
| ``` | ||
| - [**Authentication Providers**](https://coder.com/docs/v2/latest/admin/external-auth): | ||
| - Use icons for external authentication providers to make them recognizable | ||
| ## Bundled icons | ||
| Coder is distributed with a bundle of icons for popular cloud providers and | ||
| programming languages. You can see all of the icons (or suggest new ones) in our | ||
| repository on | ||
| [GitHub](https://github.com/coder/coder/tree/main/site/static/icon). | ||
| You can also view the entire list, with search and previews, by navigating to | ||
| /icons on your Coder deployment. E.g. [https://coder.example.com/icons](#). This | ||
| can be particularly useful in airgapped deployments. | ||
|  | ||
| ## External icons | ||
| You can use any image served over HTTPS as an icon, by specifying the full URL | ||
| of the image. We recommend that you use a CDN that you control, but it can be | ||
| served from any source that you trust. | ||
| You can also embed an image by using data: URLs. | ||
| - Only the https: and data: protocols are supported in icon URLs (not http:) | ||
| - Be careful when using images hosted by someone else; they might disappear or | ||
| change! | ||
| - Be careful when using data: URLs. They can get rather large, and can | ||
| negatively impact loading times for pages and queries they appear in. Only use | ||
| them for very small icons that compress well. |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.