documentation.md

Documentation

• In our documentation, when a resource field allows a maximum of only one item, we do not format that field as an array. Instead, we create a subsection specifically for this field. Within this new subsection, we enumerate all the attributes of the field. Let's illustrate this with an example: cloud_backup_schedule.html.markdown
• You can check how the documentation is rendered on the Terraform Registry via doc-preview.

Creating Resource and Data source Documentation

We autogenerate the documentation of our provider resources and data sources via tfplugindocs.

How to generate the documentation for a resource

• Make sure that the resource and data source schemas have defined the fields MarkdownDescription and Description.
  • We recommend to use Scaffolding Schema and Model Definitions to autogenerate the schema via the Open API specification.
• Add the resource/data source templates to the templates folder. See README.md for more info.
• Run the Makefile command generate-doc

export resource_name=search_deployment && make generate-doc