Skip to content

Commit de51610

Browse files
committed
Address PR comments...
1 parent 1a7f3e5 commit de51610

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

contributing/topics/reference-documentation-standards.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,8 @@ Each resource/data source must include an example, general guidelines for exampl
2020
The following conventions apply to code fences:
2121

2222
- Use the most specific code fence language that matches the snippet.
23-
- Avoid unlabeled fences unless there is a strong reason to omit the language.
2423
- Terraform configuration should use `hcl` code fences. Do not use `terraform` code fences for HCL configuration blocks.
25-
- Terraform CLI commands (`terraform init`, `terraform plan`, `terraform apply`, `terraform import`, `terraform state`, etc.) should use `shell` code fences.
26-
- CLI transcripts containing commands and output together should use `shell` or `bash`.
27-
- Bash scripts and POSIX shell examples should use `bash`.
28-
- PowerShell snippets should use `powershell`.
29-
- JSON snippets should use `json`.
30-
- YAML snippets should use `yaml`.
31-
- Markdown examples should use `markdown`.
32-
- Generic plain text output or logs where no language fits should use `text`.
33-
3424
- Keep Terraform examples copy/pasteable and self-contained.
35-
- Use `hcl` for the configuration itself and `shell` for the commands used to run it.
36-
- Do not default everything to `shell` when a more specific fence language fits the content.
3725

3826
## Arguments
3927

@@ -53,7 +41,7 @@ Arguments in the documentation are expected to be ordered as follows:
5341
The following conventions apply to argument descriptions:
5442

5543
- Descriptions should be concise, avoid adding too much detail, links to external documentation, etc. If more detail must be added, use a [note](#notes).
56-
- If an argument has `ForceNew: true`, its description must end with `Changing this forces a new <resource name> to be created.`
44+
- If an argument has `ForceNew: true`, its description must end with `Changing this forces a new resource to be created.`
5745
- 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. ``. Other common entries include:
5846
- Arguments with a single allowed value: `` The only possible value is `value1`. ``
5947
- Arguments allowing a range of values, e.g. `validation.IntBetween()`: `` Possible values range between `1` and `100`. ``

0 commit comments

Comments
 (0)