hashicorp / terraform-provider-google

Terraform Provider for Google Cloud Platform
https://registry.terraform.io/providers/hashicorp/google/latest/docs
Mozilla Public License 2.0
2.35k stars 1.75k forks source link

Standardize documentation around deletion_protection, deletion_policy, force_deletion, etc #20308

Open joe-a-t opened 3 days ago

joe-a-t commented 3 days ago

Community Note

Terraform Version & Provider Version(s)

Affected Resource(s)

Terraform Configuration

Debug Output

No response

Expected Behavior

Looking across all of these different docs pages linked below, there is a ton of overlap in deletion_protection, deletion_policy, prevent_destroy, force_destroy, etc. While I understand that many of these differences in the arguments are not unique to the Terraform provider and are dictated by a lack of standardization upstream in the Google APIs, I do think that the documentation and explanation on the Terraform provider docs pages should be far more standardized and clear about things like:

Actual Behavior

Right now, all of the above expectations are very inconsistent across the various resources. Some resources have great documentation and are really clear on all those fronts and others are extremely vague and hard to decipher.

Also, there are likely other resources with this same problem that I did not flag when opening this issue, my search was not comprehensive.

Steps to reproduce

  1. Look at the provider documentation

Important Factoids

No response

References

joe-a-t commented 2 days ago

Also possibly related once the documentation not being generated issue is fixed https://github.com/hashicorp/terraform-provider-google/issues/20328