Copyedit redpanda provider doc

docs/data-sources/cluster.md

@@ -7,30 +7,30 @@ description: |-
 
 # redpanda_cluster (Data Source)
 
-Data source for a Redpanda Cloud cluster
+Data source for a Redpanda Cloud cluster.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `id` (String) The id of the cluster
+- `id` (String) The ID of the cluster.
 
 ### Read-Only
 
-- `allow_deletion` (Boolean) allows deletion of the cluster. defaults to true. Not recommended for production use
-- `cloud_provider` (String) Must be one of aws or gcp
-- `cluster_api_url` (String) The URL of the cluster API
-- `cluster_type` (String) Type of the cluster
-- `connection_type` (String) Connection type of the cluster
-- `name` (String) Name of the cluster
-- `namespace_id` (String) The id of the namespace in which to create the cluster
-- `network_id` (String) The id of the network in which to create the cluster
-- `redpanda_version` (String) Version of Redpanda to deploy
-- `region` (String) Cloud provider specific region of the cluster
-- `tags` (Map of String) Tags to apply to the cluster
-- `throughput_tier` (String) Throughput tier of the cluster
-- `zones` (List of String) Cloud provider specific zones of the cluster
+- `allow_deletion` (Boolean) Allows deletion of the cluster. This defaults to true. Not recommended for production use.
+- `cloud_provider` (String) Must be either AWS or GCP.
+- `cluster_api_url` (String) The URL of the cluster API.
+- `cluster_type` (String) Type of cluster.
+- `connection_type` (String) Connection type of the cluster.
+- `name` (String) Name of the cluster.
+- `namespace_id` (String) The ID of the namespace in which to create the cluster.
+- `network_id` (String) The ID of the network in which to create the cluster.
+- `redpanda_version` (String) Version of Redpanda to deploy.
+- `region` (String) Cloud provider specific region of the cluster.
+- `tags` (Map of String) Tags to apply to the cluster.
+- `throughput_tier` (String) Throughput tier of the cluster.
+- `zones` (List of String) Cloud provider specific zones of the cluster.
 
 ## Usage
 
@@ -42,4 +42,4 @@ data "redpanda_cluster" "example" {
 
 ## Limitations
 
-Can only be used with Redpanda Cloud Dedicated and BYOC clusters.
+Cluster data sources can only be used with Redpanda Cloud Dedicated and BYOC clusters.

docs/data-sources/namespace.md

@@ -5,20 +5,20 @@ description: |-
   Data source for a Redpanda Cloud namespace
 ---
 
-# redpanda_namespace (Data Source)
+# redpanda_namespace (Data Source).
 
-Data source for a Redpanda Cloud namespace
+Data source for a Redpanda Cloud namespace.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `id` (String) UUID of the namespace
+- `id` (String) UUID of the namespace.
 
 ### Read-Only
 
-- `name` (String) Name of the namespace
+- `name` (String) Name of the namespace.
 
 ## Usage
 

docs/data-sources/network.md

@@ -7,23 +7,23 @@ description: |-
 
 # redpanda_network (Data Source)
 
-Data source for a Redpanda Cloud network
+Data source for a Redpanda Cloud network.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `id` (String) UUID of the network
+- `id` (String) UUID of the network.
 
 ### Read-Only
 
-- `cidr_block` (String) The cidr_block to create the network in
-- `cloud_provider` (String) The cloud provider to create the network in. Can also be set at the provider level
-- `cluster_type` (String) The type of cluster this network is associated with, can be one of dedicated or cloud
-- `name` (String) Name of the network
-- `namespace_id` (String) The id of the namespace in which to create the network
-- `region` (String) The region to create the network in. Can also be set at the provider level
+- `cidr_block` (String) The `cidr_block` in which to create the network.
+- `cloud_provider` (String) The cloud provider in which to create the network. This can also be set at the provider level.
+- `cluster_type` (String) The type of cluster this network is associated with, either dedicated or cloud.
+- `name` (String) Name of the network.
+- `namespace_id` (String) The ID of the namespace in which to create the network.
+- `region` (String) The region in which to create the network. This can also be set at the provider level.
 
 ## Usage
 

docs/index.md

@@ -1,28 +1,33 @@
 ---
 page_title: "Provider: Redpanda"
 description: |-
-  The Redpanda Data Terraform provider is used to manage Redpanda Dedicated and Cloud clusters and Kafka resources within them. To connect to a Redpanda Cloud cluster, a client_id and client_secret are required.
+  The Redpanda Terraform provider manages Dedicated Cloud clusters and Kafka resources within them. To connect to a Redpanda Cloud cluster, a client_id and client_secret are required.
 ---
 
 # Redpanda Provider
 
-The Redpanda provider is designed for managing Redpanda clusters and Kafka resources in Redpanda Dedicated and Cloud environments. It supports the provisioning, management, and configuration of clusters and Kafka resources, facilitating seamless integration into Terraform workflows.
+The Redpanda provider manages Redpanda clusters and Kafka resources in Dedicated Cloud environments. It supports the provisioning, management, and configuration of clusters and Kafka resources, facilitating seamless integration into Terraform workflows.
 
-It is also able to provide management of Kafka resources (topics, ACLs, and more) within Redpanda clusters deployed outside of Redpanda Cloud.
+It also provides management of Kafka resources (topics, ACLs, and more) within Redpanda clusters deployed outside of Redpanda Cloud.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
 
-- `client_id` (String, Sensitive) The id for the client. You need client_id AND client_secret to use this provider
-- `client_secret` (String, Sensitive) Redpanda client secret. You need client_id AND client_secret to use this provider
+- `client_id` (String, Sensitive) The ID for the client. The provider requires both `client_id` and `client_secret`.
+- `client_secret` (String, Sensitive) Redpanda client secret. The provider requires both `client_id` and `client_secret`.
 
 ## Authentication with Redpanda Cloud
 
-This provider requires a `client_id` and `client_secret` for authentication with Redpanda Cloud services, enabling users to securely manage their Redpanda resources. You can get these by creating an account in [Redpanda Cloud](https://cloudv2.redpanda.com/home) and then [creating a client in the ](https://cloudv2.redpanda.com/clients).
+The provider requires a `client_id` and `client_secret` for authentication with Redpanda Cloud. This enables users to securely manage their Redpanda resources. To get a `client_id` and `client_secret`: 
 
-## Example Provider Configuration
+. Create an account in [Redpanda Cloud](https://cloudv2.redpanda.com/home).
+. Navigate to the **Clients** tab and click **Add client**. 
+. Enter a name and description, and click **Create**.
+. Click the copy icon to get the ID and secret.
+
+## Example: Provider Configuration
 
 Terraform 1.0 or later:
 
@@ -45,7 +50,7 @@ provider "redpanda" {
 }
 ```
 
-### Example Usage for an AWS Dedicated Cluster
+### Example: AWS Dedicated Cluster
 
 ```terraform
 provider "redpanda" {}
@@ -109,7 +114,7 @@ variable "throughput_tier" {
 }
 ```
 
-### Example Usage for a GCP Dedicated Cluster
+### Example: GCP Dedicated Cluster
 
 ```terraform
 provider "redpanda" {}

docs/resources/acl.md

@@ -9,21 +9,21 @@ description: |-
 
 
 
-Creates an Access Control List (ACL) in a Redpanda cluster.
+Creates an access control list (ACL) in a Redpanda cluster.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `cluster_api_url` (String) The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
-- `host` (String) The host address to use for this ACL
-- `operation` (String) The operation type that shall be allowed or denied (e.g READ)
-- `permission_type` (String) The permission type. It determines whether the operation should be ALLOWED or DENIED
-- `principal` (String) The principal to apply this ACL for
-- `resource_name` (String) The name of the resource this ACL entry will be on
-- `resource_pattern_type` (String) The pattern type of the resource. It determines the strategy how the provided resource name is matched (LITERAL, MATCH, PREFIXED, etc ...) against the actual resource names
-- `resource_type` (String) The type of the resource (TOPIC, GROUP, etc...) this ACL shall target
+- `cluster_api_url` (String) The cluster API URL. Changing this prevents deletion of the resource on the existing cluster. It's generally better to delete an existing resource and create a new one than to change this value, unless you plan to do state imports.
+- `host` (String) The host address to use for this ACL.
+- `operation` (String) The operation type that shall be allowed or denied (for example, READ).
+- `permission_type` (String) The permission type. It determines whether the operation should be ALLOWED or DENIED.
+- `principal` (String) The principal to apply this ACL for.
+- `resource_name` (String) The name of the resource this ACL entry will be on.
+- `resource_pattern_type` (String) The pattern type of the resource. It determines the strategy how the provided resource name is matched (LITERAL, MATCH, PREFIXED, etc ...) against the actual resource names.
+- `resource_type` (String) The type of the resource (TOPIC, GROUP, etc...) this ACL shall target.
 
 ### Read-Only
 
@@ -147,8 +147,8 @@ variable "replication_factor" {
 
 ## Limitations
 
-We are not currently able to support ACL creation in self hosted clusters. This is an area of active development so expect that to change soon.
+Redpanda currently does not support creating ACLs in self-hosted clusters. 
 
 ## Import
 
-We do not support the import of ACLs into the Redpanda provider at this time.
+Redpanda currently does not support importing ACLs into the Redpanda provider.

docs/resources/cluster.md

@@ -9,33 +9,33 @@ description: |-
 
 
 
-Enables the provisioning and management of Redpanda clusters on AWS and GCP. A cluster must always have a network and namespace.
+Enables the provisioning and management of Redpanda clusters on AWS and GCP. A cluster requires a network and namespace.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `cluster_type` (String) Type of the cluster
-- `connection_type` (String) Connection type of the cluster
-- `name` (String) Name of the cluster
-- `namespace_id` (String) The id of the namespace in which to create the cluster
-- `network_id` (String) The id of the network in which to create the cluster
-- `throughput_tier` (String) Throughput tier of the cluster
+- `cluster_type` (String) Type of cluster.
+- `connection_type` (String) Connection type of the cluster.
+- `name` (String) Name of the cluster.
+- `namespace_id` (String) The ID of the namespace in which to create the cluster.
+- `network_id` (String) The ID of the network in which to create the cluster.
+- `throughput_tier` (String) Throughput tier of the cluster.
 
 ### Optional
 
-- `allow_deletion` (Boolean) allows deletion of the cluster. defaults to true. should probably be set to false for production use
-- `cloud_provider` (String) Must be one of aws or gcp
-- `redpanda_version` (String) Version of Redpanda to deploy
-- `region` (String) Cloud provider specific region of the cluster
-- `tags` (Map of String) Tags to apply to the cluster
-- `zones` (List of String) Cloud provider specific zones of the cluster
+- `allow_deletion` (Boolean) Allows deletion of the cluster. This defaults to true. Set to false for production use.
+- `cloud_provider` (String) Either AWS or GCP.
+- `redpanda_version` (String) Version of Redpanda to deploy.
+- `region` (String) Cloud provider specific region of the cluster.
+- `tags` (Map of String) Tags to apply to the cluster.
+- `zones` (List of String) Cloud provider specific zones of the cluster.
 
 ### Read-Only
 
-- `cluster_api_url` (String) The URL of the cluster API
-- `id` (String) The id of the cluster
+- `cluster_api_url` (String) The URL of the cluster API.
+- `id` (String) The ID of the cluster.
 
 ## Usage
 
@@ -165,12 +165,12 @@ variable "throughput_tier" {
 
 ## Limitations
 
-We are not currently able to support the provisioning of "BYOC" clusters using this provider. A workaround is available
+Redpanda currently does not support provisioning BYOC clusters using this provider. Workaround:
 
- * First use [RPK](https://docs.redpanda.com/current/deploy/deployment-option/cloud/create-byoc-cluster-aws/) to provision the cluster
- * Then use the provider's redpanda_cluster data source to reference the cluster for use in other resources.
+ . Use [`rpk`](https://docs.redpanda.com/current/deploy/deployment-option/cloud/create-byoc-cluster-aws/) to provision the cluster.
+ . Use the provider's `redpanda_cluster` data source to reference the cluster for use in other resources.
 
-### Example Usage of a data source BYOC to manage users and ACLs
+### Example: Usage of a data source BYOC to manage users and ACLs
 
 ```terraform
 provider "redpanda" {}

docs/resources/namespace

@@ -7,20 +7,20 @@ description: |-
 
 # redpanda_namespace (Resource)
 
-A Redpanda Cloud namespace
+A Redpanda Cloud namespace.
 
-Creates a namespace in the Redpanda Cloud. Namespaces are currently in review and may be deprecated in the future.
+Creates a namespace in Redpanda Cloud. Namespaces are currently in review and may be deprecated in the future.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `name` (String) Name of the namespace. Changing the name of a namespace will result in a new namespace being created and the old one being destroyed
+- `name` (String) Name of the namespace. Changing the name of a namespace destroys the old namespace and creates a new one.
 
 ### Read-Only
 
-- `id` (String) UUID of the namespace
+- `id` (String) UUID of the namespace.
 
 ## Usage
 

docs/resources/namespace.md

@@ -8,7 +8,7 @@ description: |-
 
 # redpanda_namespace (Resource)
 
-A Redpanda Cloud namespace
+A Redpanda Cloud namespace.
 
 
 
@@ -17,8 +17,8 @@ A Redpanda Cloud namespace
 
 ### Required
 
-- `name` (String) Name of the namespace. Changing the name of a namespace will result in a new namespace being created and the old one being destroyed
+- `name` (String) Name of the namespace. Changing the name of a namespace destroys the old namespace and creates a new one. 
 
 ### Read-Only
 
-- `id` (String) UUID of the namespace
+- `id` (String) UUID of the namespace.

docs/resources/network.md

@@ -9,26 +9,26 @@ description: |-
 
 
 
-Creates a network in the Redpanda Cloud.
+Creates a network in Redpanda Cloud.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `cidr_block` (String) The cidr_block to create the network in
-- `cluster_type` (String) The type of cluster this network is associated with, can be one of dedicated or cloud
-- `name` (String) Name of the network
-- `namespace_id` (String) The id of the namespace in which to create the network
+- `cidr_block` (String) The `cidr_block` to create the network in.
+- `cluster_type` (String) The type of cluster this network is associated with, either dedicated or cloud.
+- `name` (String) Name of the network.
+- `namespace_id` (String) The ID of the namespace in which to create the network.
 
 ### Optional
 
-- `cloud_provider` (String) The cloud provider to create the network in. Can also be set at the provider level
-- `region` (String) The region to create the network in. Can also be set at the provider level
+- `cloud_provider` (String) The cloud provider to create the network in. This can also be set at the provider level.
+- `region` (String) The region to create the network in. This can also be set at the provider level.
 
 ### Read-Only
 
-- `id` (String) The ID of the network
+- `id` (String) The ID of the network.
 
 ## Usage
 

docs/resources/topic.md

@@ -7,16 +7,16 @@ description: |-
 
 # redpanda_topic (Resource)
 
-Topic represents a Kafka topic configuration
+A topic represents a Kafka topic configuration.
 
-Creates a topic in a Redpanda Cluster
+Creates a topic in a Redpanda cluster.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `cluster_api_url` (String) The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
+- `cluster_api_url` (String) The cluster API URL. Changing this prevents deletion of the resource on the existing cluster. It is generally better to delete an existing resource and create a new one than to change this value, unless you plan to do state imports.
 - `name` (String) The name of the topic.
 
 ### Optional
@@ -148,12 +148,12 @@ variable "replication_factor" {
 
 ## Limitations
 
-We are not currently able to support topic creation in self hosted clusters. This is an area of active development so expect that to change soon.
+Redpanda currently does not support creating topics in self-hosted clusters.
 
 ## Import
 
 ```shell
 terraform import resource.redpanda_topic.example topicName,clusterId
 ```
 
-Where clusterId is the ID of the cluster in Redpanda Cloud
+Where `clusterId` is the ID of the cluster in Redpanda Cloud.