Skip to content

Commit ca52f1f

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

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/resources/metadata.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,15 @@
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. The resource containing the agent, and it's metadata, will be shown by default.
7+
Alternatively, to attach metadata to the agent, use a metadata block within a coder_agent resource.
78
---
89

910
# coder_metadata (Resource)
1011

11-
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
12+
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. The resource containing the agent, and it's metadata, will be shown by default.
13+
14+
Alternatively, to attach metadata to the agent, use a `metadata` block within a `coder_agent` resource.
1215

1316
## Example Usage
1417

provider/metadata.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ 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. " +
18+
"The resource containing the agent, and it's metadata, will be shown by default. " + "\n\n" +
19+
"Alternatively, to attach metadata to the agent, use a `metadata` block within a `coder_agent` resource.",
1820
CreateContext: func(c context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics {
1921
resourceData.SetId(uuid.NewString())
2022

0 commit comments

Comments
 (0)