Skip to content

Commit 8c9d011

Browse files
blink-so[bot]M Atif Ali
andauthored
docs: add Premium license warning for external_agent resource (#434)
* docs: add Premium license warning for external_agent resource Co-authored-by: M Atif Ali <U04T3LN8ASU+AtifCoder@users.noreply.github.com> * fix: add Premium license warning to external_agent resource description The warning needs to be in the Go code description field so it gets auto-generated into the documentation. Co-authored-by: M Atif Ali <U04T3LN8ASU+AtifCoder@users.noreply.github.com> * docs: remove manual markdown edit to let auto-generation handle warning The warning is now properly added in the Go code description field and will be auto-generated into the documentation. Co-authored-by: M Atif Ali <U04T3LN8ASU+AtifCoder@users.noreply.github.com> * docs: add Premium license warning with pricing link to external_agent Updated the Go code description to include a warning about Premium license requirement with a link to pricing, then ran make gen to regenerate the documentation. Co-authored-by: M Atif Ali <U04T3LN8ASU+AtifCoder@users.noreply.github.com> --------- Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com> Co-authored-by: M Atif Ali <U04T3LN8ASU+AtifCoder@users.noreply.github.com>
1 parent 42c19bc commit 8c9d011

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/resources/external_agent.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ page_title: "coder_external_agent Resource - terraform-provider-coder"
44
subcategory: ""
55
description: |-
66
Define an external agent to be used in a workspace.
7+
~> Warning: External agents require a Premium https://coder.com/pricing Coder license.
78
---
89

910
# coder_external_agent (Resource)
1011

1112
Define an external agent to be used in a workspace.
1213

14+
~> **Warning:** External agents require a [Premium](https://coder.com/pricing) Coder license.
15+
1316

1417

1518
<!-- schema generated by tfplugindocs -->

provider/external_agent.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ func externalAgentResource() *schema.Resource {
1212
return &schema.Resource{
1313
SchemaVersion: 1,
1414

15-
Description: "Define an external agent to be used in a workspace.",
15+
Description: "Define an external agent to be used in a workspace.\n\n~> **Warning:** External agents require a [Premium](https://coder.com/pricing) Coder license.",
1616
CreateContext: func(ctx context.Context, rd *schema.ResourceData, _ interface{}) diag.Diagnostics {
1717
rd.SetId(uuid.NewString())
1818
return nil

0 commit comments

Comments
 (0)