Skip to content

Commit ff7aabf

Browse files
committed
docs: clarify coder_metadata usage
1 parent 1d525fa commit ff7aabf

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/resources/metadata.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "coder_metadata Resource - terraform-provider-coder"
44
subcategory: ""
55
description: |-
6-
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
6+
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. To attach metadata to an entire workspace, use a metadata block within a coder_agent resource.
77
---
88

99
# coder_metadata (Resource)
1010

11-
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
11+
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. To attach metadata to an entire workspace, use a `metadata` block within a `coder_agent` resource.
1212

1313
## Example Usage
1414

provider/metadata.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ func metadataResource() *schema.Resource {
1414
SchemaVersion: 1,
1515

1616
Description: "Use this resource to attach metadata to a resource. They will be " +
17-
"displayed in the Coder dashboard.",
17+
"displayed in the Coder dashboard alongside the resource. To attach metadata " +
18+
"to the workspace, use a `metadata` block within a `coder_agent` resource.",
1819
CreateContext: func(c context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics {
1920
resourceData.SetId(uuid.NewString())
2021

0 commit comments

Comments
 (0)