terraform-plugin-docs icon indicating copy to clipboard operation
terraform-plugin-docs copied to clipboard

Provide ForceNew hints in field documentation

Open displague opened this issue 4 years ago • 3 comments

When ForceNew is enabled on a field, the documentation should note the behavior. While the description could include these details, the behavior behind ForceNew: true is generally consistent throughout providers and resources.

Originally from https://github.com/equinix/terraform-provider-metal/issues/110

displague avatar Jun 21 '21 15:06 displague

While it would be great to see this in the tool, there is also a work around available. You can check the ForceNew attribute in the schema and append something to the description yourself. Example: https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/internal/provider/provider.go#L23-L48

jacobbednarz avatar Jun 11 '22 03:06 jacobbednarz