fix: update docs icon paths to be /icon (#82)

kylecarbs · web-flow · commit e7a2598e7b21 · 2022-12-14T12:45:26.000-06:00
This was broken before!
diff --git a/docs/resources/app.md b/docs/resources/app.md
@@ -29,7 +29,7 @@ resource "coder_app" "code-server" {
   agent_id     = coder_agent.dev.id
   slug         = "code-server"
   display_name = "VS Code"
-  icon         = data.coder_workspace.me.access_url + "/icons/vscode.svg"
+  icon         = data.coder_workspace.me.access_url + "/icon/code.svg"
   url          = "http://localhost:13337"
   share        = "owner"
   subdomain    = false
@@ -71,7 +71,7 @@ resource "coder_app" "intellij" {
 - `display_name` (String) A display name to identify the app. Defaults to the slug.
 - `external` (Boolean) Specifies whether "url" is opened on the client machine instead of proxied through the workspace.
 - `healthcheck` (Block Set, Max: 1) HTTP health checking to determine the application readiness. (see [below for nested schema](#nestedblock--healthcheck))
-- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icons. Use a built-in icon with `data.coder_workspace.me.access_url + "/icons/<path>"`.
+- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icons. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
 - `name` (String, Deprecated) A display name to identify the app.
 - `relative_path` (Boolean, Deprecated) Specifies whether the URL will be accessed via a relative path or wildcard. Use if wildcard routing is unavailable. Defaults to true.
 - `share` (String) Determines the "level" which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on `coder server` (Enterprise only).
diff --git a/docs/resources/metadata.md b/docs/resources/metadata.md
@@ -58,7 +58,7 @@ resource "coder_metadata" "pod_info" {
 
 - `daily_cost` (Number) (Enterprise) The cost of this resource every 24 hours. Use the smallest denomination of your preferred currency. For example, if you work in USD, use cents.
 - `hide` (Boolean) Hide the resource from the UI.
-- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icons/<path>"`.
+- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
 - `item` (Block List) Each "item" block defines a single metadata item consisting of a key/value pair. (see [below for nested schema](#nestedblock--item))
 
 ### Read-Only
diff --git a/examples/resources/coder_app/resource.tf b/examples/resources/coder_app/resource.tf
@@ -14,7 +14,7 @@ resource "coder_app" "code-server" {
   agent_id     = coder_agent.dev.id
   slug         = "code-server"
   display_name = "VS Code"
-  icon         = data.coder_workspace.me.access_url + "/icons/vscode.svg"
+  icon         = data.coder_workspace.me.access_url + "/icon/code.svg"
   url          = "http://localhost:13337"
   share        = "owner"
   subdomain    = false
diff --git a/provider/app.go b/provider/app.go
@@ -56,7 +56,7 @@ func appResource() *schema.Resource {
 				Type: schema.TypeString,
 				Description: "A URL to an icon that will display in the dashboard. View built-in " +
 					"icons here: https://github.com/coder/coder/tree/main/site/static/icons. Use a " +
-					"built-in icon with `data.coder_workspace.me.access_url + \"/icons/<path>\"`.",
+					"built-in icon with `data.coder_workspace.me.access_url + \"/icon/<path>\"`.",
 				ForceNew: true,
 				Optional: true,
 				ValidateFunc: func(i interface{}, s string) ([]string, []error) {
diff --git a/provider/metadata.go b/provider/metadata.go
@@ -50,7 +50,7 @@ func metadataResource() *schema.Resource {
 				Type: schema.TypeString,
 				Description: "A URL to an icon that will display in the dashboard. View built-in " +
 					"icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a " +
-					"built-in icon with `data.coder_workspace.me.access_url + \"/icons/<path>\"`.",
+					"built-in icon with `data.coder_workspace.me.access_url + \"/icon/<path>\"`.",
 				ForceNew: true,
 				Optional: true,
 				ValidateFunc: func(i interface{}, s string) ([]string, []error) {
diff --git a/provider/metadata_test.go b/provider/metadata_test.go
@@ -30,7 +30,7 @@ func TestMetadata(t *testing.T) {
 				resource "coder_metadata" "agent" {
 					resource_id = coder_agent.dev.id
 					hide = true
-					icon = "/icons/storage.svg"
+					icon = "/icon/storage.svg"
 					daily_cost = 200
 					item {
 						key = "foo"
@@ -65,7 +65,7 @@ func TestMetadata(t *testing.T) {
 				for key, expected := range map[string]string{
 					"resource_id":      agent.Primary.Attributes["id"],
 					"hide":             "true",
-					"icon":             "/icons/storage.svg",
+					"icon":             "/icon/storage.svg",
 					"daily_cost":       "200",
 					"item.#":           "5",
 					"item.0.key":       "foo",
@@ -112,7 +112,7 @@ func TestMetadataDuplicateKeys(t *testing.T) {
 				resource "coder_metadata" "agent" {
 					resource_id = coder_agent.dev.id
 					hide = true
-					icon = "/icons/storage.svg"
+					icon = "/icon/storage.svg"
 					item {
 						key = "foo"
 						value = "bar"
