Skip to content
This repository was archived by the owner on Oct 18, 2023. It is now read-only.

Commit fb8695a

Browse files
committed
improve usage
1 parent 43d3c21 commit fb8695a

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

.tfdocs-config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
11
formatter: "markdown"
2+
3+
sections:
4+
hide:
5+
- requirements
6+
- providers
7+
- modules
8+
- resources
9+

README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Say you want to configure an S3 bucket as redirecting website. You can use
1313
## Usage
1414

1515
```hcl
16-
# ...
1716
1817
module "target_url" {
1918
source = "../terraform-null-url-parser"
@@ -22,11 +21,8 @@ module "target_url" {
2221
}
2322
2423
resource "aws_s3_bucket_website_configuration" "bucket_webconf" {
25-
bucket = aws_s3_bucket.route53_http_redirect_bucket.bucket
2624
27-
index_document {
28-
suffix = "index.html"
29-
}
25+
#...
3026
3127
routing_rules = <<EOF
3228
[{
@@ -40,6 +36,18 @@ EOF
4036
}
4137
```
4238

39+
This generates:
40+
41+
```
42+
[{
43+
"Redirect": {
44+
"Hostname": "registry.terraform.io",
45+
"Protocol": "https",
46+
"ReplaceKeyWith": "/namespaces/TechNative-B-V"
47+
}
48+
}]
49+
```
50+
4351
<!-- BEGIN_TF_DOCS -->
4452
## Requirements
4553

0 commit comments

Comments
 (0)