Skip to content

Commit 164783c

Browse files
authored
fix: Add terradocs to deployable module dir (#764)
1 parent 54e0791 commit 164783c

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

deployable_modules/module-template/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,34 @@
55

66
A thin wrapper around the [terraform-ibm-module-template](../../) module which includes a provider configuration meaning it can be deployed as is.
77
This is not intended to be called by one or more other modules since it contains a provider configuration, meaning it is not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers).
8+
9+
<!-- The following content is automatically populated by the pre-commit hook -->
10+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
11+
### Requirements
12+
13+
| Name | Version |
14+
|------|---------|
15+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, <1.7.0 |
16+
| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | 1.64.0 |
17+
18+
### Modules
19+
20+
| Name | Source | Version |
21+
|------|--------|---------|
22+
| <a name="module_module_template"></a> [module\_template](#module\_module\_template) | ../.. | n/a |
23+
24+
### Resources
25+
26+
No resources.
27+
28+
### Inputs
29+
30+
| Name | Description | Type | Default | Required |
31+
|------|-------------|------|---------|:--------:|
32+
| <a name="input_ibmcloud_api_key"></a> [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key) | The IBM Cloud API Key | `string` | n/a | yes |
33+
| <a name="input_region"></a> [region](#input\_region) | The IBM Cloud region | `string` | n/a | yes |
34+
35+
### Outputs
36+
37+
No outputs.
38+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)