How to handle documentation around validate in plugin framework #3077
Labels
kind/bug
Categorizes issue or PR as related to a bug.
triage/needs-information
Indicates an issue needs more information in order to work on it.
Confirmation
Terraform and Cloudflare provider version
Making an issue for this following #2977
There is the issue with the terraform docs plugin that traces back to the terraform-plugin-framework, which prevents documentation of resources from indicating that a resource must be replaced if an attribute is changed. This leads to a poor user experience, as they might not be expecting to have to replace a resource after reading the documentation.
A possible solution is to make add more functions to the utils section to work around this issue and rely on manually requiring it to be added to the schema of a resource.
Affected resource(s)
d1_database
email_routing_address
r2_bucket
ruleset
Expected output
There is documentation around when resources will have to be recreated due to plan modifiers
Actual output
The documentation is blank.
Steps to reproduce
Add a resource via the plugin framework with a planmodifier that requires replace, and the docs won't render like they do in sdkv2.
References
hashicorp/terraform-plugin-framework#625
The text was updated successfully, but these errors were encountered: