mirror of
https://github.com/ysoftdevs/terraform-aws-eks.git
synced 2026-03-27 03:41:05 +01:00
Small update after adding with-aggregate-type-defaults option to terraform-docs (#209)
This commit is contained in:
10
main.tf
10
main.tf
@@ -67,11 +67,11 @@
|
||||
* ## Doc generation
|
||||
|
||||
* Documentation should be modified within `main.tf` and generated using [terraform-docs](https://github.com/segmentio/terraform-docs).
|
||||
* Generate them like so:
|
||||
|
||||
* ```bash
|
||||
* go get github.com/segmentio/terraform-docs
|
||||
* terraform-docs md ./ | cat -s | tail -r | tail -n +2 | tail -r > README.md
|
||||
*
|
||||
* Install it with `go get github.com/segmentio/terraform-docs` or `brew install terraform-docs` and then use it to generate the `README.md` file:
|
||||
*
|
||||
* ```
|
||||
* terraform-docs --with-aggregate-type-defaults md ./ | cat -s | tail -r | tail -n +2 | tail -r > README.md
|
||||
* ```
|
||||
|
||||
* ## Contributing
|
||||
|
||||
Reference in New Issue
Block a user