docs: clarify coder_metadata usage

coder · Aug 14, 2024 · 19dd470 · 19dd470
1 parent 1d525fa
commit 19dd470
Showing 1 changed file with 2 additions and 1 deletion.
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. To attach metadata " +
+			"to an entire workspace, 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())