Terraform Provider Docs

Follow This Workflow

1. Confirm scope and documentation targets.

• Map code changes to the exact doc targets: provider index, resources, data sources, ephemeral resources, list resources, functions, actions, or guides.
• Decide whether content should come from schema descriptions, templates, or both.

2. Write schema descriptions first.

• Add precise user-facing descriptions to schema fields so generated docs stay aligned with behavior.
• Keep wording specific to argument purpose, constraints, defaults, and computed behavior.

3. Add or update template files in docs/.

• Create only files that map to implemented provider objects.
• Use HashiCorp-recommended template paths:
  • docs/index.md.tmpl
  • docs/data-sources/<name>.md.tmpl
  • docs/resources/<name>.md.tmpl
  • docs/ephemeral-resources/<name>.md.tmpl
  • docs/list-resources/<name>.md.tmpl
  • docs/functions/<name>.md.tmpl
  • docs/actions/<name>.md.tmpl (tfplugindocs generates action docs with Terraform v1.14.0+)
  • docs/guides/<name>.md.tmpl
• Keep templates focused on overview and examples; rely on generated sections for field-by-field details.
• Keep HCL examples in the examples/ directory, one example per file, pulled into templates with tffile, rather than inlined in templates (see Example File Conventions in references/hashicorp-provider-docs.md). Examples must not contain terraform, provider, or output blocks.
• For action pages, follow the structure in references/hashicorp-provider-docs.md (Action Pages section): examples must show both the action block and the action_trigger lifecycle wiring, and actions get no attribute/output section.