refactor: improve da user experience

cra-tf-validate-ignore-rules.json

@@ -9,7 +9,7 @@
         {
             "scc_rule_id": "rule-d544f217-3723-4376-b3aa-037c5f201e8d",
             "description": "Check whether Application Load Balancer for VPC uses HTTPS (SSL & TLS) instead of HTTP",
-            "ignore_reason": "This rule is not relevant since ALB will be a member of the Private path NLB.",
+            "ignore_reason": "This rule is not relevant since ALB will be a member of the Private Path NLB.",
             "is_valid": false
         }
     ]

solutions/fully-configurable/outputs.tf

@@ -65,7 +65,7 @@ output "nlb_listener_id" {
 }
 
 output "private_path_crn" {
-  description = "The CRN for this private path service gateway."
+  description = "The CRN for this Private Path service gateway."
   value       = module.private_path.private_path_crn
 }
 
@@ -75,7 +75,7 @@ output "private_path_id" {
 }
 
 output "private_path_vpc" {
-  description = "The VPC this private path service gateway resides in."
+  description = "The VPC this Private Path service gateway resides in."
   value       = module.private_path.private_path_vpc
 }
 

solutions/fully-configurable/variables.tf

@@ -10,13 +10,14 @@ variable "ibmcloud_api_key" {
 
 variable "existing_resource_group_name" {
   type        = string
-  description = "The name of an existing resource group to provision the resources. If not provided the default resource group will be used."
+  description = "The name of an existing resource group to provision the resources."
   default     = null
 }
 
 variable "region" {
   type        = string
-  description = "The region in which the VPC resources are provisioned."
+  description = "The region to provision all the resources in. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/region) about how to select different regions for different services."
+  default     = "us-south"
 }
 
 variable "provider_visibility" {
@@ -59,13 +60,13 @@ variable "prefix" {
 
 variable "private_path_tags" {
   type        = list(string)
-  description = "Optional list of tags to be added to the private path service."
+  description = "Optional list of tags to be added to the Private Path service."
   default     = []
 }
 
 variable "private_path_access_tags" {
   type        = list(string)
-  description = "A list of access tags to apply to the private path service created by the module, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial for more details."
+  description = "A list of access tags to apply to the Private Path service created by the module, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial for more details."
   default     = []
 }
 
@@ -74,7 +75,7 @@ variable "private_path_access_tags" {
 ##############################################################################
 
 variable "existing_vpc_id" {
-  description = "The ID of an existing VPC. If the user provides only the `existing_vpc_id` the private path service will be provisioned in the first subnet."
+  description = "The ID of an existing VPC. If the user provides only the `existing_vpc_id`, the Private Path service will be provisioned in the first subnet."
   type        = string
   default     = null
   validation {
@@ -107,7 +108,7 @@ variable "application_loadbalancer_type" {
 
 variable "application_loadbalancer_pool_algorithm" {
   type        = string
-  description = "The load-balancing algorithm for private path netwrok load balancer pool members. Supported values are `round_robin` or `weighted_round_robin`."
+  description = "The load-balancing algorithm for Private Path network load balancer pool members. Supported values are `round_robin` or `weighted_round_robin`."
   default     = "round_robin"
 }
 
@@ -149,7 +150,7 @@ variable "application_loadbalancer_pool_protocol" {
 
 variable "application_loadbalancer_listener_port" {
   type        = number
-  description = "The listener port for the private path netwrok load balancer."
+  description = "The listener port for the Private Path network load balancer."
   default     = 80
 }
 
@@ -183,13 +184,13 @@ variable "application_loadbalancer_listener_certificate_instance" {
 
 variable "network_loadbalancer_name" {
   type        = string
-  description = "The name of the private path netwrok load balancer."
+  description = "The name of the Private Path network load balancer."
   default     = "pp-nlb"
 }
 
 variable "network_loadbalancer_listener_port" {
   type        = number
-  description = "The listener port for the private path netwrok load balancer."
+  description = "The listener port for the Private Path network load balancer."
   default     = 80
 }
 
@@ -201,7 +202,7 @@ variable "network_loadbalancer_listener_accept_proxy_protocol" {
 
 variable "network_loadbalancer_pool_algorithm" {
   type        = string
-  description = "The load-balancing algorithm for private path netwrok load balancer pool members. Supported values are `round_robin` or `weighted_round_robin`."
+  description = "The load-balancing algorithm for Private Path network load balancer pool members. Supported values are `round_robin` or `weighted_round_robin`."
   default     = "round_robin"
 }
 
@@ -276,7 +277,7 @@ variable "private_path_name" {
 
 variable "private_path_publish" {
   type        = bool
-  description = "Set this variable to `true` to allows any account to request access to to the Private Path service. If need be, you can also unpublish where access is restricted to the account that created the Private Path service by setting this variable to `false`."
+  description = "Set this variable to `true` to allow any account to request access to the Private Path service. If need be, you can also unpublish where access is restricted to the account that created the Private Path service by setting this variable to `false`."
   default     = false
 }