Merge pull request #12 from SAP-samples/docs/modules

docs: module variable descriptions

Author: lechnerc77

sample-setups/basic-setup/directory-setup/variables.tf

@@ -12,7 +12,7 @@ variable "directory_inputs" {
   }))
   description = <<-EOT
     The inputs for the directory module.
-    - `business_unit`: Business unit of the project e.g., HR, IT or Sales
+    - `business_unit`: Business unit of the project, such as HR, IT, or Sales
     - `costcenter`: Cost center to be used for subaccounts
     - `directory_contacts`: Contact persons to be used for directories, added as label
     - `region`: The geographical region for a directory. The parameter is optional

sample-setups/basic-setup/subaccount-setup/variables.tf

@@ -5,7 +5,7 @@ variable "globalaccount" {
 
 variable "business_unit" {
   type        = string
-  description = "Business unit of the project e.g., HR, IT or Sales"
+  description = "Business unit of the project, such as HR, IT, or Sales"
 }
 
 variable "region" {

sample-setups/modules/base-directory-setup/outputs.tf

@@ -10,7 +10,7 @@ output "directory_name" {
 
 output "business_unit" {
   value       = var.business_unit
-  description = "Business unit of the project e.g., HR, IT or Sales"
+  description = "Business unit of the project, such as HR, IT, or Sales"
 }
 
 output "costcenter" {

sample-setups/modules/base-directory-setup/variables.tf

@@ -1,6 +1,6 @@
 variable "business_unit" {
   type        = string
-  description = "Business unit of the project e.g., HR, IT or Sales"
+  description = "Business unit of the project, such as HR, IT, or Sales"
 }
 
 variable "region" {
@@ -20,5 +20,5 @@ variable "costcenter" {
 
 variable "directory_contacts" {
   type        = list(string)
-  description = "Contact persons to be used for directory, added as label"
+  description = "Contact persons to be used for the directory, added as label"
 }

sample-setups/modules/sap-btp-environment/cloudfoundry/variables.tf

@@ -5,7 +5,7 @@ variable "subaccount_id" {
 
 variable "instance_name" {
   type        = string
-  description = "Name of the Cloud Foundry environment instance."
+  description = "Name of the Cloud Foundry runtime instance."
 
   validation {
     condition     = can(regex("^[a-zA-Z0-9_\\-\\.]{1,32}$", var.instance_name))
@@ -15,7 +15,7 @@ variable "instance_name" {
 
 variable "plan_name" {
   type        = string
-  description = "Desired service plan for the Cloud Foundry environment instance."
+  description = "Desired service plan for the Cloud Foundry runtime instance."
   default     = "standard"
 }
 

sample-setups/modules/sap-btp-environment/kyma/variables.tf

@@ -1,11 +1,11 @@
 variable "subaccount_id" {
   type        = string
-  description = "ID of the subaccount where the Cloud Foundry environment will be created."
+  description = "ID of the subaccount where the Kyma runtime is created."
 }
 
 variable "instance_name" {
   type        = string
-  description = "Name of the Kyma environment instance."
+  description = "Name of the Kyma runtime instance."
 
   validation {
     condition     = can(regex("^[a-zA-Z0-9_\\-\\.]{1,32}$", var.instance_name))
@@ -16,7 +16,7 @@ variable "instance_name" {
 variable "plan_name" {
   type        = string
   description = <<-EOT
-     Desired service plan for the Kyma environment instance.
+     Desired service plan for the Kyma runtime instance.
      If not provided it will be set to the default value of the region.
      EOT
   default     = null
@@ -31,7 +31,7 @@ variable "kyma_administrators" {
 variable "oidc" {
   description = "Custom OpenID Connect IdP configuration to authenticate users in your Kyma runtime."
   type = object({
-    # the URL of the OpenID issuer (use the https schema)
+    # the URL of the OpenID issuer (use the HTTPS schema)
     issuer_url = string
 
     # the client ID for the OpenID client

sample-setups/modules/sap-btp-naming-conventions-directory/outputs.tf

@@ -15,7 +15,7 @@ output "directory_labels" {
 
 output "business_unit" {
   value       = var.business_unit
-  description = "Business unit of the project e.g., HR, IT or Sales"
+  description = "Business unit of the project, such as HR, IT, or Sales"
 }
 
 output "costcenter" {

sample-setups/modules/sap-btp-naming-conventions-directory/variables.tf

@@ -1,14 +1,14 @@
 variable "business_unit" {
   type        = string
-  description = "Business unit of the project e.g., HR, IT or Sales"
+  description = "Business unit of the project, such as HR, IT, or Sales"
 }
 
 variable "region" {
   type        = string
   default     = null
   description = <<-EOT
     The geographical region for a directory. The parameter is optional
-    If you set it the possible values are: `EMEA`, `APAC`, `AMER`.
+    If you set it, the possible values are: `EMEA`, `APAC`, `AMER`.
     Default value: `null`.
   EOT
 
@@ -30,14 +30,17 @@ variable "directory_contacts" {
 
 variable "add_managed_by_label" {
   type        = bool
-  description = "Add label that resource is managed by Terraform"
+  description = <<-EOT
+  Add label that the resource is managed by Terraform
+  Default value: `true`
+  EOT
   default     = true
 }
 
 variable "management_tool" {
   type        = string
   description = <<-EOT
-    Defines which tool is used for management of infrastructure.
+    The tool that's used to manage the infrastructure.
     Possible values: `Terraform`, `OpenTofu`.
     Default value: `Terraform`.
   EOT
@@ -59,7 +62,7 @@ variable "label_name_case" {
   type        = string
   default     = "title"
   description = <<-EOT
-    Controls the letter case of the `label` names for labels generated by this module.
+    Controls the capitalization of the `label` names for labels generated by this module.
     Possible values: `lower`, `title`, `upper`.
     Default value: `title`.
   EOT
@@ -74,7 +77,7 @@ variable "label_value_case" {
   type        = string
   default     = "lower"
   description = <<-EOT
-    Controls the letter case of the `label` values for labels generated by this module.
+    Controls the capitalization of the `label` values for labels generated by this module.
     Possible values: `lower`, `title`, `upper` and `none` (no transformation).
     Default value: `lower`.
   EOT

sample-setups/modules/sap-btp-naming-conventions-subaccount/variables.tf

@@ -1,6 +1,6 @@
 variable "business_unit" {
   type        = string
-  description = "Business unit of the project e.g., HR, IT or Sales"
+  description = "Business unit of the project, such as HR, IT, or Sales"
 }
 
 variable "stage" {
@@ -37,14 +37,17 @@ variable "subaccount_contacts" {
 
 variable "add_managed_by_label" {
   type        = bool
-  description = "Add label that resource is managed by Terraform"
+  description = <<-EOT
+  Add label that the resource is managed by Terraform
+  Default value: `true`
+  EOT
   default     = true
 }
 
 variable "management_tool" {
   type        = string
   description = <<-EOT
-    Defines which tool is used for management of infrastructure.
+    The tool that's used to manage the infrastructure.
     Possible values: `Terraform`, `OpenTofu`.
     Default value: `Terraform`.
   EOT
@@ -66,7 +69,7 @@ variable "label_name_case" {
   type        = string
   default     = "title"
   description = <<-EOT
-    Controls the letter case of the `label` names for labels generated by this module.
+    Controls the capitalization of the `label` names for labels generated by this module.
     Possible values: `lower`, `title`, `upper`.
     Default value: `title`.
   EOT
@@ -81,7 +84,7 @@ variable "label_value_case" {
   type        = string
   default     = "lower"
   description = <<-EOT
-    Controls the letter case of the `label` values for labels generated by this module.
+    Controls the capitalization of the `label` values for labels generated by this module.
     Possible values: `lower`, `title`, `upper` and `none` (no transformation).
     Default value: `lower`.
   EOT