Skip to content

Commit 9c17bd7

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation and pin terraform_docs version to avoid future changes (#208)
1 parent 0a2db9f commit 9c17bd7

File tree

54 files changed

+3717
-3697
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+3717
-3697
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.46.0
3+
rev: v1.48.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_docs

‎README.md‎

Lines changed: 78 additions & 58 deletions
Large diffs are not rendered by default.

‎examples/complete/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,36 +25,36 @@ No requirements.
2525

2626
| Name | Version |
2727
|------|---------|
28-
| aws | n/a |
28+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
2929

3030
## Modules
3131

3232
| Name | Source | Version |
3333
|------|--------|---------|
34-
| complete_sg | ../../ | |
35-
| fixed_name_sg | ../../ | |
36-
| ipv4_ipv6_example | ../../ | |
37-
| main_sg | ../../ | |
38-
| vpc | terraform-aws-modules/vpc/aws | |
34+
| <a name="module_complete_sg"></a> [complete\_sg](#module\_complete\_sg) | ../../ | |
35+
| <a name="module_fixed_name_sg"></a> [fixed\_name\_sg](#module\_fixed\_name\_sg) | ../../ | |
36+
| <a name="module_ipv4_ipv6_example"></a> [ipv4\_ipv6\_example](#module\_ipv4\_ipv6\_example) | ../../ | |
37+
| <a name="module_main_sg"></a> [main\_sg](#module\_main\_sg) | ../../ | |
38+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | |
3939

4040
## Resources
4141

42-
| Name |
43-
|------|
44-
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) |
45-
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) |
42+
| Name | Type |
43+
|------|------|
44+
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) | data source |
45+
| [aws_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
4646

4747
## Inputs
4848

49-
No input.
49+
No inputs.
5050

5151
## Outputs
5252

5353
| Name | Description |
5454
|------|-------------|
55-
| this\_security\_group\_description | The description of the security group |
56-
| this\_security\_group\_id | The ID of the security group |
57-
| this\_security\_group\_name | The name of the security group |
58-
| this\_security\_group\_owner\_id | The owner ID |
59-
| this\_security\_group\_vpc\_id | The VPC ID |
55+
| <a name="output_this_security_group_description"></a> [this\_security\_group\_description](#output\_this\_security\_group\_description) | The description of the security group |
56+
| <a name="output_this_security_group_id"></a> [this\_security\_group\_id](#output\_this\_security\_group\_id) | The ID of the security group |
57+
| <a name="output_this_security_group_name"></a> [this\_security\_group\_name](#output\_this\_security\_group\_name) | The name of the security group |
58+
| <a name="output_this_security_group_owner_id"></a> [this\_security\_group\_owner\_id](#output\_this\_security\_group\_owner\_id) | The owner ID |
59+
| <a name="output_this_security_group_vpc_id"></a> [this\_security\_group\_vpc\_id](#output\_this\_security\_group\_vpc\_id) | The VPC ID |
6060
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/computed/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,33 @@ No requirements.
2323

2424
| Name | Version |
2525
|------|---------|
26-
| aws | n/a |
26+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
2727

2828
## Modules
2929

3030
| Name | Source | Version |
3131
|------|--------|---------|
32-
| http_sg | ../../modules/https-443 | |
33-
| mysql_sg | ../../modules/mysql | |
32+
| <a name="module_http_sg"></a> [http\_sg](#module\_http\_sg) | ../../modules/https-443 | |
33+
| <a name="module_mysql_sg"></a> [mysql\_sg](#module\_mysql\_sg) | ../../modules/mysql | |
3434

3535
## Resources
3636

37-
| Name |
38-
|------|
39-
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) |
40-
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) |
37+
| Name | Type |
38+
|------|------|
39+
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) | data source |
40+
| [aws_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
4141

4242
## Inputs
4343

44-
No input.
44+
No inputs.
4545

4646
## Outputs
4747

4848
| Name | Description |
4949
|------|-------------|
50-
| this\_security\_group\_description | The description of the security group |
51-
| this\_security\_group\_id | The ID of the security group |
52-
| this\_security\_group\_name | The name of the security group |
53-
| this\_security\_group\_owner\_id | The owner ID |
54-
| this\_security\_group\_vpc\_id | The VPC ID |
50+
| <a name="output_this_security_group_description"></a> [this\_security\_group\_description](#output\_this\_security\_group\_description) | The description of the security group |
51+
| <a name="output_this_security_group_id"></a> [this\_security\_group\_id](#output\_this\_security\_group\_id) | The ID of the security group |
52+
| <a name="output_this_security_group_name"></a> [this\_security\_group\_name](#output\_this\_security\_group\_name) | The name of the security group |
53+
| <a name="output_this_security_group_owner_id"></a> [this\_security\_group\_owner\_id](#output\_this\_security\_group\_owner\_id) | The owner ID |
54+
| <a name="output_this_security_group_vpc_id"></a> [this\_security\_group\_vpc\_id](#output\_this\_security\_group\_vpc\_id) | The VPC ID |
5555
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/disabled/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,29 @@ No requirements.
2525

2626
| Name | Version |
2727
|------|---------|
28-
| aws | n/a |
28+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
2929

3030
## Modules
3131

3232
| Name | Source | Version |
3333
|------|--------|---------|
34-
| complete_sg_disabled | ../../ | |
35-
| http_sg_disabled | ../../modules/http-80 | |
34+
| <a name="module_complete_sg_disabled"></a> [complete\_sg\_disabled](#module\_complete\_sg\_disabled) | ../../ | |
35+
| <a name="module_http_sg_disabled"></a> [http\_sg\_disabled](#module\_http\_sg\_disabled) | ../../modules/http-80 | |
3636

3737
## Resources
3838

39-
| Name |
40-
|------|
41-
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) |
42-
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) |
39+
| Name | Type |
40+
|------|------|
41+
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) | data source |
42+
| [aws_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
4343

4444
## Inputs
4545

46-
No input.
46+
No inputs.
4747

4848
## Outputs
4949

5050
| Name | Description |
5151
|------|-------------|
52-
| this\_security\_group\_id | The ID of the security group |
52+
| <a name="output_this_security_group_id"></a> [this\_security\_group\_id](#output\_this\_security\_group\_id) | The ID of the security group |
5353
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/dynamic/README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,32 @@ No requirements.
2525

2626
| Name | Version |
2727
|------|---------|
28-
| aws | n/a |
28+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
2929

3030
## Modules
3131

3232
| Name | Source | Version |
3333
|------|--------|---------|
34-
| http_sg | ../../modules/http-80 | |
34+
| <a name="module_http_sg"></a> [http\_sg](#module\_http\_sg) | ../../modules/http-80 | |
3535

3636
## Resources
3737

38-
| Name |
39-
|------|
40-
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) |
41-
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) |
38+
| Name | Type |
39+
|------|------|
40+
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) | data source |
41+
| [aws_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
4242

4343
## Inputs
4444

45-
No input.
45+
No inputs.
4646

4747
## Outputs
4848

4949
| Name | Description |
5050
|------|-------------|
51-
| this\_security\_group\_description | The description of the security group |
52-
| this\_security\_group\_id | The ID of the security group |
53-
| this\_security\_group\_name | The name of the security group |
54-
| this\_security\_group\_owner\_id | The owner ID |
55-
| this\_security\_group\_vpc\_id | The VPC ID |
51+
| <a name="output_this_security_group_description"></a> [this\_security\_group\_description](#output\_this\_security\_group\_description) | The description of the security group |
52+
| <a name="output_this_security_group_id"></a> [this\_security\_group\_id](#output\_this\_security\_group\_id) | The ID of the security group |
53+
| <a name="output_this_security_group_name"></a> [this\_security\_group\_name](#output\_this\_security\_group\_name) | The name of the security group |
54+
| <a name="output_this_security_group_owner_id"></a> [this\_security\_group\_owner\_id](#output\_this\_security\_group\_owner\_id) | The owner ID |
55+
| <a name="output_this_security_group_vpc_id"></a> [this\_security\_group\_vpc\_id](#output\_this\_security\_group\_vpc\_id) | The VPC ID |
5656
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/http/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,36 +25,36 @@ No requirements.
2525

2626
| Name | Version |
2727
|------|---------|
28-
| aws | n/a |
28+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
2929

3030
## Modules
3131

3232
| Name | Source | Version |
3333
|------|--------|---------|
34-
| http_mysql_1_sg | ../../modules/http-80 | |
35-
| http_mysql_2_sg | ../../modules/http-80 | |
36-
| http_sg | ../../modules/http-80 | |
37-
| http_with_egress_minimal_sg | ../../modules/http-80 | |
38-
| http_with_egress_sg | ../../modules/http-80 | |
34+
| <a name="module_http_mysql_1_sg"></a> [http\_mysql\_1\_sg](#module\_http\_mysql\_1\_sg) | ../../modules/http-80 | |
35+
| <a name="module_http_mysql_2_sg"></a> [http\_mysql\_2\_sg](#module\_http\_mysql\_2\_sg) | ../../modules/http-80 | |
36+
| <a name="module_http_sg"></a> [http\_sg](#module\_http\_sg) | ../../modules/http-80 | |
37+
| <a name="module_http_with_egress_minimal_sg"></a> [http\_with\_egress\_minimal\_sg](#module\_http\_with\_egress\_minimal\_sg) | ../../modules/http-80 | |
38+
| <a name="module_http_with_egress_sg"></a> [http\_with\_egress\_sg](#module\_http\_with\_egress\_sg) | ../../modules/http-80 | |
3939

4040
## Resources
4141

42-
| Name |
43-
|------|
44-
| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) |
45-
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) |
42+
| Name | Type |
43+
|------|------|
44+
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_group) | data source |
45+
| [aws_vpc.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
4646

4747
## Inputs
4848

49-
No input.
49+
No inputs.
5050

5151
## Outputs
5252

5353
| Name | Description |
5454
|------|-------------|
55-
| this\_security\_group\_description | The description of the security group |
56-
| this\_security\_group\_id | The ID of the security group |
57-
| this\_security\_group\_name | The name of the security group |
58-
| this\_security\_group\_owner\_id | The owner ID |
59-
| this\_security\_group\_vpc\_id | The VPC ID |
55+
| <a name="output_this_security_group_description"></a> [this\_security\_group\_description](#output\_this\_security\_group\_description) | The description of the security group |
56+
| <a name="output_this_security_group_id"></a> [this\_security\_group\_id](#output\_this\_security\_group\_id) | The ID of the security group |
57+
| <a name="output_this_security_group_name"></a> [this\_security\_group\_name](#output\_this\_security\_group\_name) | The name of the security group |
58+
| <a name="output_this_security_group_owner_id"></a> [this\_security\_group\_owner\_id](#output\_this\_security\_group\_owner\_id) | The owner ID |
59+
| <a name="output_this_security_group_vpc_id"></a> [this\_security\_group\_vpc\_id](#output\_this\_security\_group\_vpc\_id) | The VPC ID |
6060
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)