Ported documentation updates from sw module

.github/workflows/verify-registry-release.yml

@@ -49,10 +49,10 @@ jobs:
         run: |
           if [ "${{ github.event.inputs.public_release }}" == "false" ] ; then
             echo Internal release
-            MODULE_REF="app.terraform.io/SolaceDev/queue-endpoint/solacebroker"
+            MODULE_REF="app.terraform.io/SolaceDev/queue-endpoint/solacebrokerappliance"
           else
             echo Public release
-            MODULE_REF="SolaceProducts/queue-endpoint/solacebroker"
+            MODULE_REF="SolaceProducts/queue-endpoint/solacebrokerappliance"
           fi
           ci/scripts/test-module.sh ci/module-test/ $MODULE_REF "${{ github.event.inputs.release_version }}"
 

README.md

@@ -1,39 +1,39 @@
-# Solace PubSub+ Appliance Queues & Endpoints Terraform Module
+# Solace PubSub+ Software Event Broker Queues & Endpoints Terraform Module
 
-Terraform module to configure a "guaranteed messaging endpoint" or an "endpoint template" on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). 
+This Terraform module configures a "guaranteed messaging endpoint" or an "endpoint template" on the [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/). 
 
-This module supports the configuration of one of the followings:
+This module supports the configuration of one of the following:
 
 - a "_queue_" or a "_topic endpoint_": applications that make use of [Guaranteed Messaging](https://docs.solace.com/Messaging/Guaranteed-Msg/Guaranteed-Messages.htm), need [endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Endpoints.htm) configured on the event broker to persist messages. A queue may also have a list of [topic subscriptions](https://docs.solace.com/API/API-Developer-Guide/Adding-Topic-Subscriptio.htm).
 
 - a "_queue template_" or a "_topic endpoint template_": [Endpoint templates](https://docs.solace.com/Messaging/Guaranteed-Msg/Endpoint-Templates.htm?Highlight=Endpoint%20templates) may be used for new client created endpoints.
 
 The module also supports exposing a created queue or topic endpoint via JNDI for JMS applications.
 
-Full details are provided in the [Examples](#examples).
+Use case details are provided in the [Examples](#examples) section.
 
 ## Module input variables
 
 ### Required
 
-* `msg_vpn_name` - Endpoints and endpoint templates are specific to a Message VPN on the broker
+* `msg_vpn_name` - Endpoints and endpoint templates are specific to a Message VPN on the broker.
 * `endpoint_type` - The type of the endpoint or template to be created. Only one type is allowed at a time.
-* `endpoint_name` - The name of the endpoint or template to be created
-* `permission` - Queues or topic endpoints must have proper `owner` or `permission` for non-owners configured to enable clients to connect and consume messages. The user shall consider the security implications when choosing a value. For additional details, refer to the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Permissions_for_Non-Owner_Clients_..57)
+* `endpoint_name` - The name of the endpoint or template to be created.
+* `permission` - Queues or topic endpoints must have a valid `owner` or `permission` for non-owners configured to enable clients to connect and consume messages. Consider the security implications when choosing a value. For more information, see the [PubSub+ documentation](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Permissions_for_Non-Owner_Clients_..57).
 
 
 ### Optional
 
-Optional module variables are either shared by multiple types, or conditional to the type where incompatible variables will be ignored. For example, the `permission` variable is shared by all endpoint and template types but `queue_name_filter` is specific to the `queue_template` type and ignored for other types. The recommended approach to determine variable name mappings is to look up the endpoint or template resource's documentation for matching attribute names:
+Optional module variables are either shared by multiple types, or conditional to the type where incompatible variables will be ignored. For example, the `permission` variable is shared by all endpoint and template types but `queue_name_filter` is specific to the `queue_template` type and ignored for other types. To determine the variable name mappings, we recommend that you look for matching attribute names in the documentation for the endpoint or template resource:
 
 | Resource name |
 |---------------|
-|[solacebroker_msg_vpn_queue](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional)|
-|[solacebroker_msg_vpn_topic_endpoint](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional)|
-|[solacebroker_msg_vpn_queue_template](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional)|
-|[solacebroker_msg_vpn_topic_endpoint_template](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#optional)|
+|[solacebroker_msg_vpn_queue](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional)|
+|[solacebroker_msg_vpn_topic_endpoint](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint#optional)|
+|[solacebroker_msg_vpn_queue_template](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue_template#optional)|
+|[solacebroker_msg_vpn_topic_endpoint_template](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_topic_endpoint_template#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.
 
 -> The module defaults for `ingress_enabled` and `egress_enabled` optional variables are `true`, which differ from the resource attribute defaults.
 
@@ -45,11 +45,11 @@ Most optional variables' default value is `null`, meaning that if not provided t
 
 | Name | Version |
 |------|---------|
-| <a name="provider_solacebroker"></a> [solacebroker](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest) | >= 1.0 |
+| <a name="provider_solacebrokerappliance"></a> [solacebrokerappliance](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest) | >= 1.0 |
 
 ## Resources
 
-The following table shows the resources created for each `endpoint-type` value. "X" denotes a resource always created, "O" is a resource that may be created optionally  
+The following table shows the resources created for each `endpoint-type` value. "X" denotes a resource that is always created, "O" denotes a resource that you have the option to create.  
 
 | Name | queue | topic_endpoint | queue_template | topic_endpoint_template |
 |------|------|------|------|------|
@@ -63,7 +63,7 @@ The following table shows the resources created for each `endpoint-type` value.
 
 ## Examples
 
-Refer to the following configuration examples:
+The following examples demonstrate several specific use cases for this module:
 
 - Queue
     - [Exclusive queue](examples/exclusive-queue)

examples/exclusive-queue/README.md

@@ -6,49 +6,49 @@ Configuration in this directory creates an [exclusive queue](https://docs.solace
 
 ### Mandatory Inputs
 
-* `msg_vpn_name` - set to `default` in the example
-* `endpoint_type` - set to `queue`
-* `endpoint_name` - set to `testEQ` in the example
-* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue
+* `msg_vpn_name` - Set to `default` in the example.
+* `endpoint_type` - Set to `queue` in the example.
+* `endpoint_name` - Set to `testEQ` in the example.
+* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue.
 
 ### Optional Inputs
 
 The `access_type` module input variable defines if a queue is "exclusive" or "non-exclusive". The default is "exclusive", so the variable doesn't need to be strictly specified.
 
-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_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#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_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional).
 
 ### Output
 
 The module `provisioned_queue` output refers to the created queue.
 
-## Created resources
+## Created Resources
 
-This example will create following resources:
+This example will create the following resources:
 
 * `solacebroker_msg_vpn_queue`
 
 ## 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:
 
 ```bash
-git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git
+git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git
 cd examples/exclusive-queue
 ```
 
-### Adjust Provider Configuration
+### Adjust the Provider Configuration
 
-Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker.
+Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/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 [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation.
+For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation.
 

examples/non-exclusive-queue/README.md

@@ -6,49 +6,49 @@ Configuration in this directory creates a [non-exclusive queue](https://docs.sol
 
 ### Mandatory Inputs
 
-* `msg_vpn_name` - set to `default` in the example
-* `endpoint_type` - set to `queue`
-* `endpoint_name` - set to `testNEQ` in the example
-* `permission` - set to `consume` in the example to enable the receiver app to remove consumed messages from the queue
+* `msg_vpn_name` - Set to `default` in the example.
+* `endpoint_type` - Set to `queue` in the example.
+* `endpoint_name` - Set to `testNEQ` in the example.
+* `permission` - Set to `consume` in the example to enable the receiver app to remove consumed messages from the queue.
 
 ### Optional Inputs
 
 The `access_type` module input variable defines if a queue is "exclusive" or "non-exclusive". This needs to be specified for a "non-exclusive" queue.
 
-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_queue"](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#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_queue"](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/latest/docs/resources/msg_vpn_queue#optional).
 
 ### Output
 
 The module `provisioned_queue` output refers to the created queue.
 
-## Created resources
+## Created Resources
 
-This example will create following resources:
+This example will create the following resources:
 
 * `solacebroker_msg_vpn_queue`
 
 ## 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:
 
 ```bash
-git clone https://github.com/SolaceProducts/terraform-solacebroker-queue-endpoint.git
+git clone https://github.com/SolaceProducts/terraform-solacebrokerappliance-queue-endpoint.git
 cd examples/non-exclusive-queue
 ```
 
-### Adjust Provider Configuration
+### Adjust the Provider Configuration
 
-Adjust the [provider parameters](https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#schema) in `main.tf` according to your broker. The example configuration shows settings for a local broker running in Docker.
+Adjust the [provider parameters](https://registry.terraform.io/providers/SolaceProducts/solacebrokerappliance/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 [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation.
+For more information, see [Configuring Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Queues.htm#Configuring_Queues) section in the PubSub+ documentation.