How to handle documentation around validate in plugin framework

[Cyb3r-Jak3]

Confirmation

• My issue isn't already found on the issue tracker.
• I have replicated my issue using the latest version of the provider and it is still present.

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

[github-actions]

Thank you for reporting this issue! For maintainers to dig into issues it is required that all issues include the entirety of TF_LOG=DEBUG output to be provided. The only parts that should be redacted are your user credentials in the X-Auth-Key, X-Auth-Email and Authorization HTTP headers. Details such as zone or account identifiers are not considered sensitive but can be redacted if you are very cautious. This log file provides additional context from Terraform, the provider and the Cloudflare API that helps in debugging issues. Without it, maintainers are very limited in what they can do and may hamper diagnosis efforts.

This issue has been marked with triage/needs-information and is unlikely to receive maintainer attention until the log file is provided making this a complete bug report.

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[jacobbednarz]

yes, for now we just need to manually add it when we come across them or migrating schemas. i'm not going to wait for the docs plugin to address this.