Skip to content
This repository was archived by the owner on Jul 20, 2024. It is now read-only.

Commit c36eb16

Browse files
committed
Fix terraform-doc generation
1 parent 7859faa commit c36eb16

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ check:
1010
-var private_subnets_cidr_blocks=172.18.0.0/20
1111

1212
README.md: variables.tf outputs.tf
13-
sed -e '/^\/\/terraform-docs/q' $@ > $@.tmp
14-
terraform-docs md variables.tf outputs.tf >> $@.tmp
13+
sed -e '/^<!--terraform-docs-->/q' $@ > $@.tmp
14+
terraform-docs --with-aggregate-type-defaults md variables.tf outputs.tf >> $@.tmp
1515
mv $@.tmp $@

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,16 @@ See [init.sh](data/init.sh) for details.
7272
This is an open source software. Feel free to open issues and pull requests.
7373

7474

75-
//terraform-docs
75+
<!--terraform-docs-->
7676
## Inputs
7777

7878
| Name | Description | Type | Default | Required |
7979
|------|-------------|:----:|:-----:|:-----:|
8080
| image\_id | AMI of the NAT instance | string | `"ami-04b762b4289fba92b"` | no |
81-
| instance\_types | Candidates of instance type of the NAT instance | list | `<list>` | no |
81+
| instance\_types | Candidates of instance type of the NAT instance | list | `[ "t3.nano", "t3a.nano" ]` | no |
8282
| key\_name | Name of the key pair for the NAT instance | string | `""` | no |
8383
| name | Name of this NAT instance | string | n/a | yes |
84-
| private\_route\_table\_ids | List of ID of the route tables for the private subnets. You set this to assign the each default route to the NAT instance | list | `<list>` | no |
84+
| private\_route\_table\_ids | List of ID of the route tables for the private subnets. You set this to assign the each default route to the NAT instance | list | `[]` | no |
8585
| private\_subnets\_cidr\_blocks | List of CIDR blocks of the private subnets | string | n/a | yes |
8686
| public\_subnet | ID of the public subnet for the NAT instance | string | n/a | yes |
8787
| vpc\_id | ID of the VPC | string | n/a | yes |

0 commit comments

Comments
 (0)