Skip to content

📝 (docs): Cleanup README.md documentation #8

📝 (docs): Cleanup README.md documentation

📝 (docs): Cleanup README.md documentation #8

Triggered via pull request December 2, 2023 21:33
@bendoerrbendoerr
opened #19
docs
Status Success
Total duration 1m 46s
Artifacts

lint.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

4 warnings
tflint: examples/complete/variables.tf#L86
[tflint] reported by reviewdog 🐶 variable "context" is declared but not used Raw Output: examples/complete/variables.tf:86:1: warning: variable "context" is declared but not used ()
prettier: README.md#L123
[prettier] reported by reviewdog 🐶 Raw Output: README.md:123:-| Name | Description | Type | Default | Required | README.md:124:-|------|-------------|------|---------|:--------:| README.md:125:-| <a name="input_context"></a> [context](#input\_context) | Shared Context from Ben's terraform-null-label | <pre>object({<br> attributes = list(string)<br> dns_namespace = string<br> environment = string<br> instance = string<br> instance_short = string<br> namespace = string<br> region = string<br> region_short = string<br> role = string<br> role_short = string<br> project = string<br> tags = map(string)<br> })</pre> | n/a | yes | README.md:126:-| <a name="input_name"></a> [name](#input\_name) | Name of this resource | `string` | n/a | yes | README.md:127:-| <a name="input_project"></a> [project](#input\_project) | Name of the project or application, this can override the context's project | `string` | `""` | no | README.md:124:+| Name | Description | Type | Default | Required | README.md:125:+| ------------------------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | :------: | README.md:126:+| <a name="input_context"></a> [context](#input_context) | Shared Context from Ben's terraform-null-label | <pre>object({<br> attributes = list(string)<br> dns_namespace = string<br> environment = string<br> instance = string<br> instance_short = string<br> namespace = string<br> region = string<br> region_short = string<br> role = string<br> role_short = string<br> project = string<br> tags = map(string)<br> })</pre> | n/a | yes | README.md:127:+| <a name="input_name"></a> [name](#input_name) | Name of this resource | `string` | n/a | yes | README.md:128:+| <a name="input_project"></a> [project](#input_project) | Name of the project or application, this can override the context's project | `string` | `""` | no |
prettier: README.md#L131
[prettier] reported by reviewdog 🐶 Raw Output: README.md:131:-| Name | Description | README.md:132:-|------|-------------| README.md:133:-| <a name="output_attributes"></a> [attributes](#output\_attributes) | List of attributes | README.md:134:-| <a name="output_delimiter"></a> [delimiter](#output\_delimiter) | Delimiter between `namespace`, `environment`, `stage`, `name` and `attributes` | README.md:135:-| <a name="output_dns_name"></a> [dns\_name](#output\_dns\_name) | Normalized DNS Name | README.md:136:-| <a name="output_environment"></a> [environment](#output\_environment) | Normalized environment | README.md:137:-| <a name="output_id"></a> [id](#output\_id) | Disambiguated ID | README.md:138:-| <a name="output_label_order"></a> [label\_order](#output\_label\_order) | The naming order of the id output and Name tag | README.md:139:-| <a name="output_name"></a> [name](#output\_name) | Normalized name | README.md:140:-| <a name="output_namespace"></a> [namespace](#output\_namespace) | Normalized namespace | README.md:141:-| <a name="output_project"></a> [project](#output\_project) | Normalized project | README.md:142:-| <a name="output_tags"></a> [tags](#output\_tags) | Normalized Tag map | README.md:143:-| <a name="output_tags_as_list_of_maps"></a> [tags\_as\_list\_of\_maps](#output\_tags\_as\_list\_of\_maps) | Additional tags as a list of maps, which can be used in several AWS resources | README.md:132:+| Name | Description | README.md:133:+| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | README.md:134:+| <a name="output_attributes"></a> [attributes](#output_attributes) | List of attributes | README.md:135:+| <a name="output_delimiter"></a> [delimiter](#output_delimiter) | Delimiter between `namespace`, `environment`, `stage`, `name` and `attributes` | README.md:136:+| <a name="output_dns_name"></a> [dns_name](#output_dns_name) | Normalized DNS Name | README.md:137:+| <a name="output_environment"></a> [environment](#output_environment) | Normalized environment | README.md:138:+| <a name="output_id"></a> [id](#output_id) | Disambiguated ID | README.md:139:+| <a name="output_label_order"></a> [label_order](#output_label_order) | The naming order of the id output and Name tag | README.md:140:+| <a name="output_name"></a> [name](#output_name) | Normalized name | README.md:141:+| <a name="output_namespace"></a> [namespace](#output_namespace) | Normalized namespace | README.md:142:+| <a name="output_project"></a> [project](#output_project) | Normalized project | README.md:143:+| <a name="output_tags"></a> [tags](#output_tags) | Normalized Tag map | README.md:144:+| <a name="output_tags_as_list_of_maps"></a> [tags_as_list_of_maps](#output_tags_as_list_of_maps) | Additional tags as a list of maps, which can be used in several AWS resources | README.md:145:+
markdownlint: README.md#L1
[markdownlint] reported by reviewdog 🐶 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "<br/>"] Raw Output: README.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "<br/>"]