Skip to content

Commit c85b5f7

Browse files
blink-so[bot]bpmct
andauthored
docs: add link to styling options documentation (#423)
Add link to coder.com/docs styling options documentation in the styling parameter description to help users understand available styling attributes. The link is added in the Go source code so it gets properly generated into the documentation by tfplugindocs. Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com> Co-authored-by: bpmct <22407953+bpmct@users.noreply.github.com>
1 parent d5496af commit c85b5f7

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

docs/data-sources/parameter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ data "coder_parameter" "home_volume_size" {
150150
- `mutable` (Boolean) Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
151151
- `option` (Block List) Each `option` block defines a value for a user to select from. (see [below for nested schema](#nestedblock--option))
152152
- `order` (Number) The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
153-
- `styling` (String) JSON encoded string containing the metadata for controlling the appearance of this parameter in the UI. This option is purely cosmetic and does not affect the function of the parameter in terraform.
153+
- `styling` (String) JSON encoded string containing the metadata for controlling the appearance of this parameter in the UI. This option is purely cosmetic and does not affect the function of the parameter in terraform. See [styling options documentation](https://coder.com/docs/admin/templates/extending-templates/dynamic-parameters#available-styling-options) for available styling attributes.
154154
- `type` (String) The type of this parameter. Must be one of: `"string"`, `"number"`, `"bool"`, `"list(string)"`.
155155
- `validation` (Block List, Max: 1) Validate the input of a parameter. (see [below for nested schema](#nestedblock--validation))
156156

provider/parameter.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,8 @@ func parameterDataSource() *schema.Resource {
205205
Type: schema.TypeString,
206206
Default: `{}`,
207207
Description: "JSON encoded string containing the metadata for controlling the appearance of this parameter in the UI. " +
208-
"This option is purely cosmetic and does not affect the function of the parameter in terraform.",
208+
"This option is purely cosmetic and does not affect the function of the parameter in terraform. " +
209+
"See [styling options documentation](https://coder.com/docs/admin/templates/extending-templates/dynamic-parameters#available-styling-options) for available styling attributes.",
209210
Optional: true,
210211
},
211212
"mutable": {

0 commit comments

Comments
 (0)