Next stepsĬongratulations! You have enhanced the provider with documentation generation capabilities. View the generated files in the docs directory to verify that the data source, provider, and resource documentation contains the expected descriptions, examples, and schema information. For example:Įxamples/resources/hashicups_order/resource.tf. Replace TYPE with the name of the resource or data source. Data Sources: examples/data-sources/TYPE/data-source.tf.Resources: examples/resources/TYPE/resource.tf.Provider: examples/provider/provider.tf.

The tfplugindocs tool will automatically include Terraform configurationĮxamples from files with the following naming conventions: SchemaResponse ) Add configuration examples func (d *coffeesDataSource ) Schema ( _ context. Schema defines the schema for the data source. The generation uses schema descriptions and conventionally placed files to produce provider documentation that is compatible with the Terraform Registry. The terraform-plugin-docs Go module cmd/tfplugindocs command enables providers to implement documentation generation.

This ensures that the documentation generation works as expected. This enhances the resource documentation to include an example of how to import the resources that support it. This enhances the documentation to include example Terraform configurations. This enhances the documentation to include a description for the provider itself, its data sources and resources, and each of their attributes. This enables the provider to automatically generate data source and resource documentation.

Add terraform-plugin-docs to the provider.

In this tutorial, you will add documentation generation capabilities to a provider that interacts with the API of a fictional coffee-shop application called HashiCups.

Terraform plugins docs