Fix example linting errors

Author: koendelaat

examples/default/README.md

@@ -63,7 +63,7 @@ Be-aware some shells will print some end of line character `%`.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | `null` | no |
+| <a name="input_environment"></a> [environment](#input\_environment) | Environment name, used as prefix | `string` | `null` | no |
 | <a name="input_github_app"></a> [github\_app](#input\_github\_app) | GitHub for API usages. | <pre>object({<br>    id         = string<br>    key_base64 = string<br>  })</pre> | n/a | yes |
 
 ## Outputs

examples/default/variables.tf

@@ -8,6 +8,8 @@ variable "github_app" {
 }
 
 variable "environment" {
+  description = "Environment name, used as prefix"
+
   type    = string
   default = null
 }

examples/multi-runner/README.md

@@ -80,7 +80,7 @@ Be-aware some shells will print some end of line character `%`.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | `null` | no |
+| <a name="input_environment"></a> [environment](#input\_environment) | Environment name, used as prefix | `string` | `null` | no |
 | <a name="input_github_app"></a> [github\_app](#input\_github\_app) | GitHub for API usages. | <pre>object({<br>    id         = string<br>    key_base64 = string<br>  })</pre> | n/a | yes |
 
 ## Outputs

examples/multi-runner/variables.tf

@@ -8,6 +8,8 @@ variable "github_app" {
 }
 
 variable "environment" {
+  description = "Environment name, used as prefix"
+
   type    = string
   default = null
 }

examples/prebuilt/README.md

@@ -129,9 +129,9 @@ Be-aware some shells will print some end of line character `%`.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_ami_name_filter"></a> [ami\_name\_filter](#input\_ami\_name\_filter) | n/a | `string` | `"github-runner-amzn2-x86_64-*"` | no |
+| <a name="input_ami_name_filter"></a> [ami\_name\_filter](#input\_ami\_name\_filter) | AMI name filter for the action runner AMI. By default amazon linux 2 is used. | `string` | `"github-runner-amzn2-x86_64-*"` | no |
 | <a name="input_github_app"></a> [github\_app](#input\_github\_app) | GitHub for API usages. | <pre>object({<br>    id         = string<br>    key_base64 = string<br>  })</pre> | n/a | yes |
-| <a name="input_runner_os"></a> [runner\_os](#input\_runner\_os) | n/a | `string` | `"linux"` | no |
+| <a name="input_runner_os"></a> [runner\_os](#input\_runner\_os) | The EC2 Operating System type to use for action runner instances (linux,windows). | `string` | `"linux"` | no |
 
 ## Outputs
 

examples/prebuilt/variables.tf

@@ -8,11 +8,15 @@ variable "github_app" {
 }
 
 variable "runner_os" {
+  description = "The EC2 Operating System type to use for action runner instances (linux,windows)."
+
   type    = string
   default = "linux"
 }
 
 variable "ami_name_filter" {
+  description = "AMI name filter for the action runner AMI. By default amazon linux 2 is used."
+
   type    = string
   default = "github-runner-amzn2-x86_64-*"
 }

examples/ubuntu/providers.tf

@@ -5,10 +5,10 @@ provider "aws" {
       Example = local.environment
     }
   }
-  // If you use roles with specific permissions please add your role
-  // assume_role {
-  //   role_arn = "arn:aws:iam::123456789012:role/MyAdminRole"
-  // }
+  #   If you use roles with specific permissions please add your role
+  #   assume_role {
+  #     role_arn = "arn:aws:iam::123456789012:role/MyAdminRole"
+  #   }
 }
 
 provider "random" {