Editorial fixes

README.md

@@ -1,42 +1,42 @@
 # Solace PubSub+ Software Event Broker JNDI Terraform Module
 
-Terraform module to configure a [connection factory object](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) in the JNDI store of a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). 
+This Terraform module configures a [connection factory object](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) in the JNDI store of a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). 
 
-Full details are provided in the [Examples](#examples).
+Use case details are provided in the [Examples](#examples) section.
 
 ## Related modules
 
-To use JNDI, access must be enabled on the Message VPN. This can be configured using the [Service Module](TODO:fixlink). By default, JNDI access is not enabled on Solace PubSub+ appliances, but it is enabled on Solace PubSub+ software event brokers.
+To use JNDI, access must be enabled on the Message VPN. You can configure this using the [Service Module](TODO:fixlink). By default, JNDI access is not enabled on Solace PubSub+ appliances, but it is enabled on Solace PubSub+ software event brokers.
 
 To configure JNDI managed objects (JNDI Topics and Queues) when provisioning a PubSub+ queue or topic endpoint, use the [Queues & Endpoints Module](TODO:fixlink).
 
 ## Module input variables
 
 ### Required
 
-* `msg_vpn_name` - the Message VPN on the broker for which JNDI configuration is created
-* `connection_factory_name` - The name of the connection factory to be created
+* `msg_vpn_name` - the Message VPN on the event broker for which JNDI configuration is created.
+* `connection_factory_name` - The name of the connection factory to be created.
 
 ### Optional
 
-* `local_transactions_enabled` - specifies if the connection factory shall support local transactions. The default is `false`.
-* `xa_enabled` - specifies if the connection factory shall support XA transactions. When enabled it also enables local transactions support. The default is `false`. Note: this variable has the same name and use as the underlying resource attribute.
+* `local_transactions_enabled` - Specifies if the connection factory shall support local transactions. The default is `false`.
+* `xa_enabled` - Specifies if the connection factory shall support XA transactions. When enabled it also enables local transactions support. The default is `false`. Note: this variable has the same name and use as the underlying resource attribute.
 
-Additional optional module variables names are the same as the underlying connection factory resource attributes. The recommended approach to determine variable name mappings is to look up the resource's documentation for matching attribute names:
+Additional optional module variables names are the same as the underlying connection factory resource attributes. To determine the variable name mappings, we recommend that you look for matching attribute names in the documentation for the resource:
 
 | Resource name |
 |---------------|
 |[solacebroker_msg_vpn_jndi_connection_factory](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional)|
 
-Most optional variables' default value is `null`, meaning that if not provided then the resource default value will be provisioned on the broker.
+The default value for most of the optional variables is `null`, meaning that if you don’t provide a value then the default value of the resource is provisioned on the event broker.
 
 ## Module outputs
 
 [Module outputs](https://developer.hashicorp.com/terraform/language/values/outputs) provide reference to created resources. Any reference to a resource that has not been created will be set to `(null)`.
 
 Outputs:
-* `connection_factory` - the connection factory created
-* `xa_connection_factory` - an alternative reference to the same `connection_factory`, only if an XA connection factory has been created
+* `connection_factory` - The connection factory created.
+* `xa_connection_factory` - An alternative reference to the same `connection_factory`, only if an XA connection factory has been created.
 
 ## Providers
 
@@ -54,11 +54,11 @@ The following table shows the resources created.
 
 ## Examples
 
-Refer to the following configuration examples:
+The following examples demonstrate several specific use cases for this module:
 
-- [Connection factory](examples/basic/)
-    - [Connection factory with local transactions support](examples/local-transactions-support/)
-    - [Connection factory with XA transactions support](examples/xa-transactions-support/)
+- [Basic connection factory](examples/basic/)
+- [Connection factory with local transactions support](examples/local-transactions-support/)
+- [Connection factory with XA transactions support](examples/xa-transactions-support/)
 
 ## Module use recommendations
 

examples/basic/README.md

@@ -6,30 +6,30 @@ Configuration in this directory creates a [connection factory](https://docs.sola
 
 ### Required Inputs
 
-* `msg_vpn_name` - set to `default` in the example
-* `connection_factory_name` - set to `/JNDI/CF/GettingStarted` in the example
+* `msg_vpn_name` - Set to `default` in the example.
+* `connection_factory_name` - Set to `/JNDI/CF/GettingStarted` in the example.
 
 ### Optional Inputs
 
-Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_jndi_connection_factory"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional).
+Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_jndi_connection_factory"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional).
 
 ### Output
 
 The module `provisioned_connection_factory` output refers to the created connection factory.
 
-## Created resources
+## Created Resources
 
-This example will create following resources:
+This example will create the following resources:
 
 * `solacebroker_msg_vpn_jndi_connection_factory`
 
 ## Running the Example
 
-### Access to a PubSub+ broker
+### Access to a PubSub+ Event Broker
 
-If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started.
+If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started.
 
-### Sample source code
+### Sample Source Code
 
 The sample is available from the module GitHub repo:
 
@@ -38,13 +38,13 @@ git clone https://github.com/SolaceProducts/terraform-solacebroker-jndi.git
 cd examples/basic
 ```
 
-### Adjust Provider Configuration
+### Adjust the Provider Configuration
 
 Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker.
 
-### Create the resource
+### Create the Resource
 
-Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm)
+Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm).
 
 Execute from this folder:
 
@@ -54,8 +54,8 @@ terraform plan
 terraform apply
 ```
 
-Run `terraform destroy` to clean up created resources when no longer needed.
+Run `terraform destroy` to clean up the created resources when they are no longer needed.
 
 ## Additional Documentation
 
-Refer to the [Connection Factories](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) section in the PubSub+ documentation.
+For more information, see [Connection Factories](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) section in the PubSub+ documentation.

examples/local-transactions-support/README.md

@@ -6,34 +6,34 @@ Configuration in this directory creates a [connection factory](https://docs.sola
 
 ### Required Inputs
 
-* `msg_vpn_name` - set to `default` in the example
-* `connection_factory_name` - set to `/JNDI/CF/LocalTransSupport` in the example
+* `msg_vpn_name` - Set to `default` in the example.
+* `connection_factory_name` - Set to `/JNDI/CF/LocalTransSupport` in the example.
 
 ### Optional Inputs
 
-* `local_transactions_enabled` - shall be set to `true` to configure a connection factory with local transactions support.
+* `local_transactions_enabled` - Shall be set to `true` to configure a connection factory with local transactions support.
 
 Note: connection factories must have the `transport_direct_transport_enabled` input variable disabled to support local and XA transactions. This is automatically ensured in this module if `local_transactions_enabled` is `true`.
 
-Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_jndi_connection_factory"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional).
+Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_jndi_connection_factory"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional).
 
 ### Output
 
 The module `provisioned_connection_factory` output refers to the created connection factory.
 
-## Created resources
+## Created Resources
 
-This example will create following resources:
+This example will create the following resources:
 
 * `solacebroker_msg_vpn_jndi_connection_factory`
 
 ## Running the Example
 
-### Access to a PubSub+ broker
+### Access to a PubSub+ Event Broker
 
-If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started.
+If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started.
 
-### Sample source code
+### Sample Source Code
 
 The sample is available from the module GitHub repo:
 
@@ -42,13 +42,13 @@ git clone https://github.com/SolaceProducts/terraform-solacebroker-jndi.git
 cd examples/local-transactions-support
 ```
 
-### Adjust Provider Configuration
+### Adjust the Provider Configuration
 
 Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker.
 
-### Create the resource
+### Create the Resource
 
-Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm)
+Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm).
 
 Execute from this folder:
 
@@ -58,9 +58,9 @@ terraform plan
 terraform apply
 ```
 
-Run `terraform destroy` to clean up created resources when no longer needed.
+Run `terraform destroy` to clean up the created resources when they are no longer needed.
 
 ## Additional Documentation
 
-Refer to the [Connection Factories](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) section in the PubSub+ documentation.
+For more information, see [Connection Factories](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) section in the PubSub+ documentation.
 

examples/xa-transactions-support/README.md

@@ -6,36 +6,36 @@ Configuration in this directory creates a [connection factory](https://docs.sola
 
 ### Required Inputs
 
-* `msg_vpn_name` - set to `default` in the example
-* `connection_factory_name` - set to `/JNDI/CF/XATransSupport` in the example
+* `msg_vpn_name` - Set to `default` in the example.
+* `connection_factory_name` - Set to `/JNDI/CF/XATransSupport` in the example.
 
 ### Optional Inputs
 
-* `xa_enabled` - shall be set to `true` to configure a connection factory with XA support.
+* `xa_enabled` - Shall be set to `true` to configure a connection factory with XA support.
 
 Note: connection factories must have the `transport_direct_transport_enabled` input variable disabled to support local and XA transactions. This is automatically ensured in this module if `xa_enabled` is `true`.
 
-Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted then the default for the related resource attribute will be configured on the broker. For attributes and defaults, refer to the [documentation of "solacebroker_msg_vpn_jndi_connection_factory"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional).
+Optional module input variables have the same name as the attributes of the underlying provider resource. If omitted, then the default for the related resource attribute will be configured on the broker. For a list of attributes and the corresponding defaults, see the [documentation of "solacebroker_msg_vpn_jndi_connection_factory"](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/resources/msg_vpn_jndi_connection_factory#optional).
 
 ### Output
 
 The module `provisioned_connection_factory` output refers to the created connection factory.
 
 The module `xa_provisioned_connection_factory` output is an alternative way to refer to the created connection factory, it will be a valid non-null object only if XA is enabled.
 
-## Created resources
+## Created Resources
 
-This example will create following resources:
+This example will create the following resources:
 
 * `solacebroker_msg_vpn_jndi_connection_factory`
 
 ## Running the Example
 
-### Access to a PubSub+ broker
+### Access to a PubSub+ Event Broker
 
-If you don't already have access to a broker, refer to the [Developers page](https://www.solace.dev/) for options to get started.
+If you don't already have access to a broker, see the [Developers page](https://www.solace.dev/) for options to get started.
 
-### Sample source code
+### Sample Source Code
 
 The sample is available from the module GitHub repo:
 
@@ -44,13 +44,13 @@ git clone https://github.com/SolaceProducts/terraform-solacebroker-jndi.git
 cd examples/xa-transactions-support
 ```
 
-### Adjust Provider Configuration
+### Adjust the Provider Configuration
 
 Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker.
 
-### Create the resource
+### Create the Resource
 
-Hint: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm)
+Tip: You can verify configuration changes on the broker, before and after, using the [PubSub+ Broker Manager Web UI](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.htm).
 
 Execute from this folder:
 
@@ -60,9 +60,9 @@ terraform plan
 terraform apply
 ```
 
-Run `terraform destroy` to clean up created resources when no longer needed.
+Run `terraform destroy` to clean up the created resources when they are no longer needed.
 
 ## Additional Documentation
 
-Refer to the [Connection Factories](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) section in the PubSub+ documentation.
+For more information, see [Connection Factories](https://docs.solace.com/API/Solace-JMS-API/Connection-Factories.htm) section in the PubSub+ documentation.