Skip to content

Commit 55fe8aa

Browse files
committed
Fix doc generator
1 parent 8eba95f commit 55fe8aa

File tree

2 files changed

+19
-21
lines changed

2 files changed

+19
-21
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Basic usage of this module is as follows:
2121
```hcl
2222
module "folders" {
2323
source = "terraform-google-modules/folders/google"
24-
version = "> 1.0.0"
24+
version = "~> 0.1"
2525
26-
parent = "folders/65552901371"
26+
parent_id = "65552901371"
2727
2828
names = [
2929
"dev",
@@ -49,28 +49,27 @@ module "folders" {
4949
Functional examples are included in the
5050
[examples](./examples/) directory.
5151

52-
[^]: (autogen_docs_start)
53-
52+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
5453
## Inputs
5554

5655
| Name | Description | Type | Default | Required |
5756
|------|-------------|:----:|:-----:|:-----:|
58-
| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list | `<list>` | no |
59-
| folder\_admin\_roles | List of roles that will be applied to per folder owners on their respective folder. | list | `<list>` | no |
60-
| names | Folder names. | list | `<list>` | no |
61-
| parent | IThe resource name of the parent Folder or Organization. Must be of the form folders/folder_id or organizations/org_id | string | n/a | yes |
62-
| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list | `<list>` | no |
57+
| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list(string) | `<list>` | no |
58+
| folder\_admin\_roles | List of roles that will be applied to per folder owners on their respective folder. | list(string) | `<list>` | no |
59+
| names | Folder names. | list(string) | `<list>` | no |
60+
| parent | The resource name of the parent Folder or Organization. Must be of the form folders/folder_id or organizations/org_id | string | n/a | yes |
61+
| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list(string) | `<list>` | no |
6362
| prefix | Optional prefix to enforce uniqueness of folder names. | string | `""` | no |
64-
| set\_roles | Set roles to actors passed in role_members variable. | string | `"false"` | no |
63+
| set\_roles | Set roles to actors passed in role_members variable. | bool | `"false"` | no |
6564

6665
## Outputs
6766

6867
| Name | Description |
6968
|------|-------------|
70-
| ids | Map of name => folder resource id. |
71-
| names | Map of name => folder resource name. |
69+
| names\_and\_display\_names | Map of name => folder resource name. |
70+
| names\_and\_ids | Map of name => folder resource id. |
7271

73-
[^]: (autogen_docs_end)
72+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
7473

7574
## Requirements
7675

examples/simple_example/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,24 @@
22

33
This example illustrates how to use the `folders` module.
44

5-
[^]: (autogen_docs_start)
6-
5+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
76
## Inputs
87

98
| Name | Description | Type | Default | Required |
109
|------|-------------|:----:|:-----:|:-----:|
11-
| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list | `<list>` | no |
12-
| names | Folder names. | list | `<list>` | no |
10+
| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list(string) | `<list>` | no |
11+
| names | Folder names. | list(string) | `<list>` | no |
1312
| parent\_id | Id of the resource under which the folder will be placed. | string | n/a | yes |
14-
| parent\_type | Type of the parent reosurce, defaults to organization. | string | `"organization"` | no |
15-
| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list | `<list>` | no |
13+
| parent\_type | Type of the parent reosurce, defaults to organization. | string | `"folders"` | no |
14+
| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list(string) | `<list>` | no |
1615

1716
## Outputs
1817

1918
| Name | Description |
2019
|------|-------------|
21-
| ids | Map of name => folder resource id. |
20+
| names\_and\_ids | Map of name => folder resource id. |
2221

23-
[^]: (autogen_docs_end)
22+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2423

2524
To provision this example, run the following from within this directory:
2625
- `terraform init` to get the plugins

0 commit comments

Comments
 (0)