You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing/topics/reference-documentation-standards.md
+22-16Lines changed: 22 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,17 +80,17 @@ The following conventions apply to argument descriptions:
80
80
- Descriptions should be concise, avoid adding too much detail, links to external documentation, etc. If more detail must be added, use a [note](#notes).
81
81
- If an argument has `ForceNew: true`, its description must end with `Changing this forces a new resource to be created.`
82
82
- If the argument has a default value, this must be documented using `` Defaults to `default1`. ``
83
-
- If the argument has validation allowing only specific inputs, e.g. `validation.StringInSlice()`, these must be documented using `` Possible values are `value1`, `value2`, and `value3. ``.
83
+
- If the argument has validation allowing only specific inputs, e.g. `validation.StringInSlice()`, these must be documented using `` Possible values are `valueOne`, `valueTwo`, and `valueThree`. ``.
84
84
* Other common entries include:
85
-
- Arguments with a single allowed value: `` The only possible value is `value1`. ``
85
+
- Arguments with a single allowed value: `` The only possible value is `valueOne`. ``
86
86
- Arguments allowing a range of values, e.g. `validation.IntBetween()`: `` Possible values range between `1` and `100`. ``
87
87
88
88
89
89
Examples:
90
90
91
-
-`name` - (Required) The name which should be used for this resource.
92
-
-`argument_enabled` - (Optional) Should this argument be enabled? Possible values are `true` and `false`. Defaults to `false`.
93
-
-`argument_in_gb` - (Optional) The argument in gigabytes. Possible values range between `4` and `256`.
91
+
-`name` - (Required) The name which should be used for this resource. Changing this forces a new resource to be created.
92
+
-`argument_enabled` - (Optional) Whether the `argument` is enabled. Defaults to `false`.
93
+
-`argument_in_gb` - (Optional) The argument in gigabytes. Possible values range between `4` and `256`. Defaults to `129`.
94
94
95
95
### Ordering
96
96
@@ -122,29 +122,35 @@ Example:
122
122
123
123
The following arguments are supported:
124
124
125
-
*`name` - (Required) The name which should be used for this resource.
125
+
*`name` - (Required) The name which should be used for this resource. Changing this forces a new resource to be created.
126
126
127
-
*`resource_group_name` - (Required) The name which should be used for this resource.
127
+
-> **Note:** The `name` must begin and end with an alphanumeric character, and may contain only alphanumeric characters and hyphens.
128
128
129
-
*`location` - (Required) The name which should be used for this resource.
129
+
*`resource_group_name` - (Required) The name of the Resource Group where the resource should exist. Changing this forces a new resource to be created.
130
130
131
-
*`argument` - (Required) This argument does something nifty.
131
+
*`location` - (Required) The Azure Region where the resource should exist. Changing this forces a new resource to be created.
132
+
133
+
*`argument` - (Required) This argument does something nifty. Possible values are `nifty`, `super-nifty`, and `stupendous`.
132
134
133
135
*`block_argument` - (Optional) A `block_argument` as defined below.
134
136
135
-
*`some_other_argument` - (Optional) This argument does something magical.
137
+
*`some_other_argument` - (Optional) This argument does something magical. Possible values are `magical` or `muggle`. Defaults to `magical`.
138
+
139
+
*`tags` - (Optional) Specifies a mapping of tags to assign to the resource.
136
140
137
141
---
138
142
139
143
A `block_argument` supports the following:
140
144
141
-
*`block_argument` - (Required) Specifies the block_argument of this nested item.
145
+
*`argument` - (Required) The argument that should be used for this block argument. Possible values are `this`, `that`, and `other`.
146
+
147
+
*`some_other_block_argument` - (Required) Specifies the some other block argument. The only possible value is `value`.
142
148
143
-
*`some_other_block_argument` - (Required) Specifies the some_other_block_argument of this nested item exists.
149
+
*`optional_block_argument` - (Optional) The optional block argument for the resource. Possible values range between `1` and `2048`. Defaults to `1024`.
144
150
145
-
*`optional_block_argument` - (Optional) Specifies the optional_block_argument of this nested item exists.
151
+
*`some_other_optional_block_argument` - (Optional) Specifies the some other optional block argument. Defaults to `false`.
146
152
147
-
*`some_other_optional_block_argument`- (Optional) Specifies the some_other_optional_block_argument of this nested item exists.
153
+
~> **Note:** The argument `some_other_optional_block_argument`is required when `argument` is set to `stupendous`.
148
154
149
155
## Attributes Reference
150
156
@@ -254,7 +260,7 @@ To add a warning note, use `~> **Note:**`, within the Terraform registry documen
254
260
For example, an argument that is optional but required when another argument is set to `true`:
255
261
256
262
```markdown
257
-
*`optional_argument_enabled` - (Optional) Is the optional argumentenabled? Defaults to `false`.
263
+
*`optional_argument_enabled` - (Optional) Whether the `optional argument` is enabled. Defaults to `false`.
258
264
259
265
*`optional_argument` - (Optional) An optional argument.
260
266
@@ -270,7 +276,7 @@ To add a caution note, use `!> **Note:**`, within the Terraform registry documen
270
276
For example, an argument that when set to `true` cannot be reversed without recreating the resource:
271
277
272
278
```markdown
273
-
*`irreversible_argument_enabled` - (Optional) Is irreversible argumentenabled? Defaults to `false`.
279
+
*`irreversible_argument_enabled` - (Optional) Whether the `irreversible argument` is enabled. Defaults to `false`.
274
280
275
281
!> **Note:** The argument `irreversible_argument_enabled` cannot be disabled after being enabled.
0 commit comments