confluentinc / terraform-provider-confluent

Terraform Provider for Confluent
Apache License 2.0
31 stars 64 forks source link

Typo in Upgrade to Terraform 2.0.0 Guide #412

Closed lcua-cup closed 3 months ago

lcua-cup commented 3 months ago

Hello, I am a bit confused with some of the written guidelines. There are 2 things that I have noticed:

  1. While reading this portion: Changes to confluent_schema_registry_region data source, It says: image

Should it be confluent_schema_registry_region and not confluent_schema_registry_cluster? Sorry, I am confused.

  1. In data.confluent_schema_registry_cluster Resource, It says the data.confluent_schema_registry_cluster will be deprecated, or will it be the confluent_schema_registry_cluster resource? image
linouk23 commented 3 months ago

Thanks for creating this issue @lcua-cup!

It does look like a typo to me and we'll make sure to update the guide in our next release 👍

In short, it should have been

### Changes to `confluent_schema_registry_region` data source

Deprecated `confluent_schema_registry_region`
[data source](https://registry.terraform.io/providers/confluentinc/confluent/1.65.0/docs/data-sources/confluent_schema_registry_region) will be removed in version `2.0.0`.

Remove the `confluent_schema_registry_region` [data source](https://registry.terraform.io/providers/confluentinc/confluent/1.65.0/docs/data-sources/confluent_schema_registry_region) only from TF configuration (as data sources are not stored in the TF state) instead
to avoid `Warning: Deprecated Resource` messages.

To remove `confluent_schema_registry_region` [data source](https://registry.terraform.io/providers/confluentinc/confluent/1.65.0/docs/data-sources/confluent_schema_registry_region) from TF configuration, you can just remove its definition:

#### Before
data "confluent_schema_registry_region" "essentials" {
  # ...
}
```

After

```
# empty
```


which is exactly what you have suggested 👍 

> It says the data.confluent_schema_registry_cluster will be deprecated, or will it be the confluent_schema_registry_cluster resource?

That's a great catch! We'll only deprecate `confluent_schema_registry_cluster` resource and we'll make sure to fix this typo as well, thanks again!
lcua-cup commented 3 months ago

Fantastic, thank you!

linouk23 commented 3 months ago

Update: Our docs have been updated. Thanks again for spotting the typos @lcua-cup!