Skip to content

Commit 779ab71

Browse files
authored
Fix readme yaml (#75)
1 parent 7cb20c9 commit 779ab71

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.yaml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
#
1414

1515
# Name of this project
16-
name:
16+
name: terraform-example-module
1717

1818
# Logo for this project
1919
#logo: docs/logo.png
@@ -28,7 +28,7 @@ copyrights:
2828
year: "2021"
2929

3030
# Canonical GitHub repo
31-
github_repo:
31+
github_repo: cloudposse/terraform-example-module
3232

3333
# Badges to display
3434
badges:
@@ -53,6 +53,18 @@ related:
5353

5454
# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
5555
references:
56+
- name: "Cloud Posse Documentation"
57+
url: "https://docs.cloudposse.com"
58+
description: "The Cloud Posse Developer Hub (documentation)"
59+
- name: "Terraform Standard Module Structure"
60+
description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
61+
url: "https://www.terraform.io/docs/language/modules/develop/structure.html"
62+
- name: "Terraform Module Requirements"
63+
description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
64+
url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
65+
- name: "Terraform Version Pinning"
66+
description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
67+
url: "https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version"
5668

5769
# Short description of this project
5870
description: |-

0 commit comments

Comments
 (0)