docs: clarify coder_metadata usage

coder · Aug 14, 2024 · 97e4fb5 · 97e4fb5
1 parent 1d525fa
commit 97e4fb5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/resources/metadata.md b/docs/resources/metadata.md
@@ -3,12 +3,12 @@
 page_title: "coder_metadata Resource - terraform-provider-coder"
 subcategory: ""
 description: |-
-  Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
+  Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. The metadata of the resource containing the agent will be shown by default.To attach metadata to the agent, use a metadata block within a coder_agent resource.
 ---
 
 # coder_metadata (Resource)
 
-Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
+Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. The metadata of the resource containing the agent will be shown by default.To attach metadata to the agent, use a `metadata` block within a `coder_agent` resource.
 
 ## Example Usage
 

diff --git a/provider/metadata.go b/provider/metadata.go
@@ -14,7 +14,8 @@ func metadataResource() *schema.Resource {
 		SchemaVersion: 1,
 
 		Description: "Use this resource to attach metadata to a resource. They will be " +
-			"displayed in the Coder dashboard.",
+			"displayed in the Coder dashboard alongside the resource. The metadata of the resource containing the agent will be shown by default." +
+			"To attach metadata to the agent, use a `metadata` block within a `coder_agent` resource.",
 		CreateContext: func(c context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics {
 			resourceData.SetId(uuid.NewString())