Skip to content

Commit 5e4ee0b

Browse files
committed
docs(update-docs): Update example docs for the registry
1 parent 794bf53 commit 5e4ee0b

File tree

4 files changed

+89
-42
lines changed

4 files changed

+89
-42
lines changed

docs/index.md

+50-29
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,66 @@
1-
2-
# epic Provider
31
---
4-
# generated by https://github.com/hashicorp/terraform-plugin-docs
52
page_title: "epic Provider"
63
subcategory: ""
74
description: |-
85
96
---
107

11-
# epic Provider
8+
# Epic Provider
129

1310

1411

1512
## Example Usage
1613

1714
```terraform
1815
provider "epic" {}
16+
17+
provider "aws" {
18+
region = "us-east-1"
19+
}
20+
21+
resource "epic_random_name" "movie_name" {
22+
media_type = "movie"
23+
title = "lord of the rings"
24+
}
25+
26+
27+
resource "epic_random_quote" "lotr_quote" {
28+
media_type = "movie"
29+
title = "lord of the rings"
30+
}
31+
32+
resource "aws_s3_bucket" "epic" {
33+
bucket = epic_random_name.movie_name.name
34+
35+
tags = {
36+
Name = epic_random_name.movie_name.name
37+
Description = epic_random_quote.lotr_quote.quote
38+
}
39+
}
40+
41+
output "s3_bucket_name" {
42+
value = aws_s3_bucket.epic.bucket
43+
}
1944
```
2045

21-
<!-- schema generated by tfplugindocs -->
22-
## Schema
23-
Media Type: anime
24-
Titles:
25-
- one_piece
26-
- spy_x_family
27-
28-
Media Type: movie
29-
Titles:
30-
- jurassic_park
31-
- lord_of_the_rings
32-
- star_wars
33-
34-
Media Type: tv_series
35-
Titles:
36-
- breaking_bad
37-
- game_of_thrones
38-
39-
Media Type: video_game
40-
Titles:
41-
- final_fantasy_vii
42-
- kingdom_hearts_1
43-
- the_witcher
44-
45-
All Media Types: anime movie tv_series video_game
46+
## Available Media Types
47+
48+
Available media types are `anime` `movie` `tv_series` and `video_games`
49+
50+
## Media Type: anime Titles:
51+
one_piece
52+
spy_x_family
53+
54+
## Media Type: movie Titles:
55+
jurassic_park
56+
lord_of_the_rings
57+
star_wars
58+
59+
## Media Type: tv_series Titles:
60+
breaking_bad
61+
game_of_thrones
62+
63+
## Media Type: video_game Titles:
64+
final_fantasy_vii
65+
kingdom_hearts_1
66+
the_witcher

docs/resources/random_name.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "epic_random_name Resource - epic"
2+
page_title: "epic_random_name Resource - terraform-provider-epic"
43
subcategory: ""
54
description: |-
65
Generates a random character name based on the media type and title specified.
@@ -13,9 +12,9 @@ Generates a random character name based on the media type and title specified.
1312
## Example Usage
1413

1514
```terraform
16-
resource "epic_random_name" "movie_name" {
17-
media_type = "movie"
18-
title = "lord of the rings"
15+
resource "epic_random_name" "movie_name" {
16+
media_type = "movie"
17+
title = "lord of the rings"
1918
}
2019
```
2120

@@ -24,7 +23,7 @@ resource "epic_random_name" "movie_name" {
2423

2524
### Required
2625

27-
- `media_type` (String) The type of media, e.g., 'movie' or 'tv_series'.
26+
- `media_type` (String) The type of media, e.g., 'movie' or 'tv_series'. Valid options are `anime` `movie` `tv_series` or `video_games`
2827
- `title` (String) The title of the media to base the name generation on.
2928

3029
### Read-Only

docs/resources/random_quote.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "epic_random_quote Resource - epic"
2+
page_title: "epic_random_quote Resource - terraform-provider-epic"
43
subcategory: ""
54
description: |-
65
Generates a random quote based on the media type and title specified.
@@ -13,9 +12,9 @@ Generates a random quote based on the media type and title specified.
1312
## Example Usage
1413

1514
```terraform
16-
resource "epic_random_quote" "got_quote" {
17-
media_type = "tv_series"
18-
title = "game of thrones"
15+
resource "epic_random_quote" "got_quote" {
16+
media_type = "tv_series"
17+
title = "game of thrones"
1918
}
2019
```
2120

@@ -24,7 +23,7 @@ resource "epic_random_quote" "got_quote" {
2423

2524
### Required
2625

27-
- `media_type` (String) The type of media, e.g., 'movie' or 'tv_series'.
26+
- `media_type` (String) The type of media, e.g., 'movie' or 'tv_series'. Valid options are `anime` `movie` `tv_series` or `video_games`
2827
- `title` (String) The title of the media to base the quote generation on.
2928

3029
### Read-Only

examples/provider/provider.tf

+29-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
provider "epic" {}
1+
provider "epic" {}
2+
3+
provider "aws" {
4+
region = "us-east-1"
5+
}
6+
7+
resource "epic_random_name" "movie_name" {
8+
media_type = "movie"
9+
title = "lord of the rings"
10+
}
11+
12+
13+
resource "epic_random_quote" "lotr_quote" {
14+
media_type = "movie"
15+
title = "lord of the rings"
16+
}
17+
18+
resource "aws_s3_bucket" "epic" {
19+
bucket = epic_random_name.movie_name.name
20+
21+
tags = {
22+
Name = epic_random_name.movie_name.name
23+
Description = epic_random_quote.lotr_quote.quote
24+
}
25+
}
26+
27+
output "s3_bucket_name" {
28+
value = aws_s3_bucket.epic.bucket
29+
}

0 commit comments

Comments
 (0)