Skip to content

Commit 6897401

Browse files
committed
updating documentation template
1 parent 836b72d commit 6897401

2 files changed

Lines changed: 10 additions & 12 deletions

File tree

terraform/.terraform.docs.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,16 @@ sections:
1414

1515
content: |-
1616
# Overview
17-
This module declares all of the resources necessary to create AWS IAM related resources.
17+
Resources created by this code repository.
1818
19-
# Terraform Directory
2019
{{ .Header }}
2120
{{ .Modules }}
2221
{{ .Resources }}
2322
{{ .Inputs }}
2423
{{ .Outputs }}
2524
{{ .Providers }}
2625
{{ .Requirements }}
27-
{{ .Footer }}
28-
To automatically update this documentation, install terraform-docs on your local machine run the following:
29-
cd <directory of README location to update>
30-
terraform-docs -c .terraform.docs.yml .
26+
{{ .Footer }}
3127
3228
# Directory Structure
3329
Terraform directory structure
@@ -40,6 +36,9 @@ content: |-
4036
- 📄 [aws-groups.tf](https://github.com/hackforla/ops-security/tree/cb/example/terraform/modules/aws-groups) - maintain groups here
4137
- 📄 [aws-users.tf](https://github.com/hackforla/ops-security/tree/cb/example/terraform/modules/aws-users) - maintain users here
4238
39+
To automatically update this documentation, install terraform-docs on your local machine run the following:
40+
`cd <directory of README location to update>`
41+
`terraform-docs -c .terraform.docs.yml .`
4342
output:
4443
file: README.md
4544
mode: replace

terraform/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<!-- BEGIN_TF_DOCS -->
22
# Overview
3-
This module declares all of the resources necessary to create AWS IAM related resources.
3+
Resources created by this code repository.
44

5-
# Terraform Directory
65

76
## Modules
87

@@ -15,10 +14,7 @@ This module declares all of the resources necessary to create AWS IAM related re
1514

1615

1716

18-
19-
To automatically update this documentation, install terraform-docs on your local machine run the following:
20-
cd <directory of README location to update>
21-
terraform-docs -c .terraform.docs.yml .
17+
2218

2319
# Directory Structure
2420
Terraform directory structure
@@ -31,4 +27,7 @@ Terraform directory structure
3127
- 📄 [aws-groups.tf](https://github.com/hackforla/ops-security/tree/cb/example/terraform/modules/aws-groups) - maintain groups here
3228
- 📄 [aws-users.tf](https://github.com/hackforla/ops-security/tree/cb/example/terraform/modules/aws-users) - maintain users here
3329

30+
To automatically update this documentation, install terraform-docs on your local machine run the following:
31+
`cd <directory of README location to update>`
32+
`terraform-docs -c .terraform.docs.yml .`
3433
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)