Skip to content

Commit 713bf2e

Browse files
terraform-docs: automated action
1 parent e9e5701 commit 713bf2e

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

examples/complete/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,43 @@ No inputs.
2323
## Outputs
2424

2525
No outputs.
26+
27+
<!-- BEGIN_TF_DOCS -->
28+
## Usage
29+
30+
To run this example you need to execute:
31+
32+
```bash
33+
$ terraform init
34+
$ terraform plan
35+
$ terraform apply
36+
```
37+
38+
Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.
39+
40+
## Requirements
41+
42+
| Name | Version |
43+
|------|---------|
44+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.8.4 |
45+
46+
## Providers
47+
48+
No providers.
49+
50+
## Modules
51+
52+
No modules.
53+
54+
## Resources
55+
56+
No resources.
57+
58+
## Inputs
59+
60+
No inputs.
61+
62+
## Outputs
63+
64+
No outputs.
65+
<!-- END_TF_DOCS -->

examples/minimal/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,43 @@ No inputs.
2323
## Outputs
2424

2525
No outputs.
26+
27+
<!-- BEGIN_TF_DOCS -->
28+
## Usage
29+
30+
To run this example you need to execute:
31+
32+
```bash
33+
$ terraform init
34+
$ terraform plan
35+
$ terraform apply
36+
```
37+
38+
Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.
39+
40+
## Requirements
41+
42+
| Name | Version |
43+
|------|---------|
44+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.8.4 |
45+
46+
## Providers
47+
48+
No providers.
49+
50+
## Modules
51+
52+
No modules.
53+
54+
## Resources
55+
56+
No resources.
57+
58+
## Inputs
59+
60+
No inputs.
61+
62+
## Outputs
63+
64+
No outputs.
65+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)