Commitca52f1f

committed

docs: clarifycoder_metadata usage

1 parent1d525fa commitca52f1fCopy full SHA for ca52f1f

File tree

-3

lines changed

-3

lines changed

Lines changed: 5 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,15 @@`
`3`	`3`	`page_title:"coder_metadata Resource - terraform-provider-coder"`
`4`	`4`	`subcategory:""`
`5`	`5`	`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.`
`7`	`8`	`---`
`8`	`9`
`9`	`10`	`#coder_metadata (Resource)`
`10`	`11`
`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.
`12`	`15`
`13`	`16`	`##Example Usage`
`14`	`17`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,9 @@ func metadataResource() *schema.Resource {`
`14`	`14`	`SchemaVersion:1,`
`15`	`15`
`16`	`16`	`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.",
`18`	`20`	`CreateContext:func(c context.Context,resourceData*schema.ResourceData,iinterface{}) diag.Diagnostics {`
`19`	`21`	`resourceData.SetId(uuid.NewString())`
`20`	`22`

Comments

(0)