review module README files

NHingerl · NHingerl · commit 8438c69e3c6c · 2025-04-22T17:17:06.000+02:00
diff --git a/sample-setups/modules/base-directory-setup/README.md b/sample-setups/modules/base-directory-setup/README.md
@@ -31,16 +31,16 @@ This module encapsulates the creation of a directory on SAP BTP following standa
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project e.g., HR, IT or Sales | `string` | n/a | yes |
+| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project, such as HR, IT, or Sales | `string` | n/a | yes |
 | <a name="input_costcenter"></a> [costcenter](#input\_costcenter) | Cost center to be used for subaccounts | `string` | n/a | yes |
-| <a name="input_directory_contacts"></a> [directory\_contacts](#input\_directory\_contacts) | Contact persons to be used for directory, added as label | `list(string)` | n/a | yes |
-| <a name="input_region"></a> [region](#input\_region) | The geographical region for a directory. The parameter is optional<br/>If you set it the possible values are: `EMEA`, `APAC`, `AMER`.<br/>Default value: `null`. | `string` | `null` | no |
+| <a name="input_directory_contacts"></a> [directory\_contacts](#input\_directory\_contacts) | Contact persons to be used for the directory, added as label | `list(string)` | n/a | yes |
+| <a name="input_region"></a> [region](#input\_region) | The geographical region for a directory. The parameter is optional<br/>If you set it, the possible values are: `EMEA`, `APAC`, `AMER`.<br/>Default value: `null`. | `string` | `null` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_business_unit"></a> [business\_unit](#output\_business\_unit) | Business unit of the project e.g., HR, IT or Sales |
+| <a name="output_business_unit"></a> [business\_unit](#output\_business\_unit) | Business unit of the project, such as HR, IT, or Sales |
 | <a name="output_costcenter"></a> [costcenter](#output\_costcenter) | Cost center to be used for subaccounts |
 | <a name="output_directory_id"></a> [directory\_id](#output\_directory\_id) | Technical ID of the directory |
 | <a name="output_directory_name"></a> [directory\_name](#output\_directory\_name) | The name of the directory |
diff --git a/sample-setups/modules/sap-btp-environment/kyma/README.md b/sample-setups/modules/sap-btp-environment/kyma/README.md
@@ -1,6 +1,6 @@
-# SAP BTP - Kyma Environment Setup
+# SAP BTP - Kyma Runtime Setup
 
-This module encapsulates the creation of a Kyma environment in a subaccount on SAP BTP. The configuration is a basic setup. In a real world scenario, you would likely want to customize the setup further with respect to the available parameters like machine type etc. as described in the [documentation](https://help.sap.com/docs/btp/sap-business-technology-platform/provisioning-and-update-parameters-in-kyma-environment) depending on the stage of the environment (development, test, production).
+This module encapsulates the creation of a Kyma runtime in a subaccount on SAP BTP. The configuration is a basic setup. In a real-world scenario, you typically customize the setup further with the available parameters like machine type, depending on the stage of the environment (development, test, production). For details, see [Provisioning and Updating Parameters in the Kyma Environment](https://help.sap.com/docs/btp/sap-business-technology-platform/provisioning-and-update-parameters-in-kyma-environment).
 
 ## Requirements
 
@@ -32,11 +32,11 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_instance_name"></a> [instance\_name](#input\_instance\_name) | Name of the Kyma environment instance. | `string` | n/a | yes |
+| <a name="input_instance_name"></a> [instance\_name](#input\_instance\_name) | Name of the Kyma runtime instance. | `string` | n/a | yes |
 | <a name="input_kyma_administrators"></a> [kyma\_administrators](#input\_kyma\_administrators) | Users to be assigned as administrators. | `list(string)` | `[]` | no |
-| <a name="input_oidc"></a> [oidc](#input\_oidc) | Custom OpenID Connect IdP configuration to authenticate users in your Kyma runtime. | <pre>object({<br/>    # the URL of the OpenID issuer (use the https schema)<br/>    issuer_url = string<br/><br/>    # the client ID for the OpenID client<br/>    client_id = string<br/><br/>    #the name of a custom OpenID Connect claim for specifying user groups<br/>    groups_claim = string<br/><br/>    # the list of allowed cryptographic algorithms used for token signing. The allowed values are defined by RFC 7518.<br/>    signing_algs = set(string)<br/><br/>    # the prefix for all usernames. If you don't provide it, username claims other than “email” are prefixed by the issuerURL to avoid clashes. To skip any prefixing, provide the value as -.<br/>    username_prefix = string<br/><br/>    # the name of a custom OpenID Connect claim for specifying a username<br/>    username_claim = string<br/>  })</pre> | `null` | no |
-| <a name="input_plan_name"></a> [plan\_name](#input\_plan\_name) | Desired service plan for the Kyma environment instance.<br/>If not provided it will be set to the default value of the region. | `string` | `null` | no |
-| <a name="input_subaccount_id"></a> [subaccount\_id](#input\_subaccount\_id) | ID of the subaccount where the Cloud Foundry environment will be created. | `string` | n/a | yes |
+| <a name="input_oidc"></a> [oidc](#input\_oidc) | Custom OpenID Connect IdP configuration to authenticate users in your Kyma runtime. | <pre>object({<br/>    # the URL of the OpenID issuer (use the HTTPS schema)<br/>    issuer_url = string<br/><br/>    # the client ID for the OpenID client<br/>    client_id = string<br/><br/>    #the name of a custom OpenID Connect claim for specifying user groups<br/>    groups_claim = string<br/><br/>    # the list of allowed cryptographic algorithms used for token signing. The allowed values are defined by RFC 7518.<br/>    signing_algs = set(string)<br/><br/>    # the prefix for all usernames. If you don't provide it, username claims other than “email” are prefixed by the issuerURL to avoid clashes. To skip any prefixing, provide the value as -.<br/>    username_prefix = string<br/><br/>    # the name of a custom OpenID Connect claim for specifying a username<br/>    username_claim = string<br/>  })</pre> | `null` | no |
+| <a name="input_plan_name"></a> [plan\_name](#input\_plan\_name) | Desired service plan for the Kyma runtime instance.<br/>If not provided, it will be set to the default value of the region. | `string` | `null` | no |
+| <a name="input_subaccount_id"></a> [subaccount\_id](#input\_subaccount\_id) | ID of the subaccount where the Kyma runtime is created. | `string` | n/a | yes |
 
 ## Outputs
 
diff --git a/sample-setups/modules/sap-btp-naming-conventions-directory/README.md b/sample-setups/modules/sap-btp-naming-conventions-directory/README.md
@@ -12,15 +12,15 @@ This module encapsulates the naming conventions for SAP BTP directories and the
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_add_managed_by_label"></a> [add\_managed\_by\_label](#input\_add\_managed\_by\_label) | Add label that resource is managed by Terraform | `bool` | `true` | no |
-| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project e.g., HR, IT or Sales | `string` | n/a | yes |
+| <a name="input_add_managed_by_label"></a> [add\_managed\_by\_label](#input\_add\_managed\_by\_label) | Add label that the resource is managed by Terraform.<br/>Default value: `true`. | `bool` | `true` | no |
+| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project, such as HR, IT, or Sales | `string` | n/a | yes |
 | <a name="input_costcenter"></a> [costcenter](#input\_costcenter) | Cost center to be used for subaccounts | `string` | n/a | yes |
 | <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used for namings | `string` | `"-"` | no |
 | <a name="input_directory_contacts"></a> [directory\_contacts](#input\_directory\_contacts) | Contact persons to be used for directories, added as label | `list(string)` | n/a | yes |
-| <a name="input_label_name_case"></a> [label\_name\_case](#input\_label\_name\_case) | Controls the letter case of the `label` names for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`. | `string` | `"title"` | no |
-| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of the `label` values for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Default value: `lower`. | `string` | `"lower"` | no |
-| <a name="input_management_tool"></a> [management\_tool](#input\_management\_tool) | Defines which tool is used for management of infrastructure.<br/>Possible values: `Terraform`, `OpenTofu`.<br/>Default value: `Terraform`. | `string` | `"Terraform"` | no |
-| <a name="input_region"></a> [region](#input\_region) | The geographical region for a directory. The parameter is optional<br/>If you set it the possible values are: `EMEA`, `APAC`, `AMER`.<br/>Default value: `null`. | `string` | `null` | no |
+| <a name="input_label_name_case"></a> [label\_name\_case](#input\_label\_name\_case) | Controls the capitalization of the `label` names for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`. | `string` | `"title"` | no |
+| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the capitalization of the `label` values for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Default value: `lower`. | `string` | `"lower"` | no |
+| <a name="input_management_tool"></a> [management\_tool](#input\_management\_tool) | The tool that's used to manage the infrastructure.<br/>Possible values: `Terraform`, `OpenTofu`.<br/>Default value: `Terraform`. | `string` | `"Terraform"` | no |
+| <a name="input_region"></a> [region](#input\_region) | The geographical region for a directory. The parameter is optional<br/>If you set it, the possible values are: `EMEA`, `APAC`, `AMER`.<br/>Default value: `null`. | `string` | `null` | no |
 
 ## Outputs
 
diff --git a/sample-setups/modules/sap-btp-naming-conventions-subaccount/README.md b/sample-setups/modules/sap-btp-naming-conventions-subaccount/README.md
@@ -28,15 +28,15 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_add_managed_by_label"></a> [add\_managed\_by\_label](#input\_add\_managed\_by\_label) | Add label that resource is managed by Terraform | `bool` | `true` | no |
-| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project e.g., HR, IT or Sales | `string` | n/a | yes |
+| <a name="input_add_managed_by_label"></a> [add\_managed\_by\_label](#input\_add\_managed\_by\_label) | Add label that the resource is managed by Terraform.<br/>Default value: `true`.  | `bool` | `true` | no |
+| <a name="input_business_unit"></a> [business\_unit](#input\_business\_unit) | Business unit of the project, such as HR, IT, or Sales | `string` | n/a | yes |
 | <a name="input_company_name"></a> [company\_name](#input\_company\_name) | Company name to be used for subaccount subdomains. The parameter is optional<br/>Default value: `null`. | `string` | `null` | no |
 | <a name="input_costcenter"></a> [costcenter](#input\_costcenter) | Cost center to be used for subaccounts | `string` | n/a | yes |
 | <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used for namings | `string` | `"-"` | no |
-| <a name="input_label_name_case"></a> [label\_name\_case](#input\_label\_name\_case) | Controls the letter case of the `label` names for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`. | `string` | `"title"` | no |
-| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of the `label` values for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Default value: `lower`. | `string` | `"lower"` | no |
-| <a name="input_management_tool"></a> [management\_tool](#input\_management\_tool) | Defines which tool is used for management of infrastructure.<br/>Possible values: `Terraform`, `OpenTofu`.<br/>Default value: `Terraform`. | `string` | `"Terraform"` | no |
-| <a name="input_stage"></a> [stage](#input\_stage) | Stage of the environment to be setup up.<br/>Possible values: `Dev`, `Test`, `Prod`, `Shared`. | `string` | n/a | yes |
+| <a name="input_label_name_case"></a> [label\_name\_case](#input\_label\_name\_case) | Controls the capitalization of the `label` names for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`. | `string` | `"title"` | no |
+| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the capitalization of the `label` values for labels generated by this module.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Default value: `lower`. | `string` | `"lower"` | no |
+| <a name="input_management_tool"></a> [management\_tool](#input\_management\_tool) | The tool that's used to manage the infrastructure.<br/>Possible values: `Terraform`, `OpenTofu`.<br/>Default value: `Terraform`. | `string` | `"Terraform"` | no |
+| <a name="input_stage"></a> [stage](#input\_stage) | Stage of the environment to be set up.<br/>Possible values: `Dev`, `Test`, `Prod`, `Shared`. | `string` | n/a | yes |
 | <a name="input_subaccount_contacts"></a> [subaccount\_contacts](#input\_subaccount\_contacts) | Contact persons to be used for subaccounts, added as label | `list(string)` | n/a | yes |
 
 ## Outputs
diff --git a/sample-setups/modules/sap-btp-subaccount-default-entitlements/README.md b/sample-setups/modules/sap-btp-subaccount-default-entitlements/README.md
@@ -1,6 +1,6 @@
 # SAP BTP - Default Subaccount Entitlements
 
-This module encapsulates the default entitlements for SAP BTP subaccounts. It distinguishes between the different stages of the environment (Dev, Test, Prod, Shared) and provides a default set of entitlements for each stage.
+This module encapsulates the default entitlements for SAP BTP subaccounts. It distinguishes between the different development stages of the environment (Dev, Test, Prod, Shared) and provides a default set of entitlements for each stage.
 
 ## Requirements
 
