Skip to content

Commit d7bb4b7

Browse files
committed
Update docs
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
1 parent 0fa92e0 commit d7bb4b7

2 files changed

Lines changed: 12 additions & 14 deletions

File tree

website/docs/d/repository_pages.html.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Use this data source to retrieve GitHub Pages configuration for a repository.
1313

1414
```hcl
1515
data "github_repository_pages" "example" {
16-
owner = "my-org"
1716
repository = "my-repo"
1817
}
1918
```
@@ -22,8 +21,6 @@ data "github_repository_pages" "example" {
2221

2322
The following arguments are supported:
2423

25-
- `owner` - (Required) The owner of the repository.
26-
2724
- `repository` - (Required) The repository name to get GitHub Pages information for.
2825

2926
## Attribute Reference
@@ -40,9 +37,11 @@ The following attributes are exported:
4037

4138
- `source` - The source branch and directory for the rendered Pages site. See [Source](#source) below for details.
4239

43-
- `status` - The GitHub Pages site's build status (e.g., `building` or `built`).
40+
- `build_status` - The GitHub Pages site's build status (e.g., `building` or `built`).
41+
42+
- `api_url` - The API URL of the GitHub Pages resource.
4443

45-
- `url` - The API URL of the GitHub Pages resource.
44+
- `public` - Whether the GitHub Pages site is public.
4645

4746
### Source
4847

website/docs/r/repository_pages.html.markdown

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ resource "github_repository" "example" {
3131
}
3232
3333
resource "github_repository_pages" "example" {
34-
owner = "my-org"
35-
repository_name = github_repository.example.name
34+
repository = github_repository.example.name
3635
build_type = "legacy"
3736
3837
source {
@@ -58,8 +57,7 @@ resource "github_repository" "example" {
5857
}
5958
6059
resource "github_repository_pages" "example" {
61-
owner = "my-org"
62-
repository_name = github_repository.example.name
60+
repository = github_repository.example.name
6361
build_type = "workflow"
6462
}
6563
```
@@ -80,8 +78,7 @@ resource "github_repository" "example" {
8078
}
8179
8280
resource "github_repository_pages" "example" {
83-
owner = "my-org"
84-
repository_name = github_repository.example.name
81+
repository = github_repository.example.name
8582
build_type = "legacy"
8683
cname = "example.com"
8784
@@ -96,16 +93,16 @@ resource "github_repository_pages" "example" {
9693

9794
The following arguments are supported:
9895

99-
- `owner` - (Required) The owner of the repository to configure GitHub Pages for.
100-
101-
- `repository_name` - (Required) The repository name to configure GitHub Pages for.
96+
- `repository` - (Required) The repository name to configure GitHub Pages for.
10297

10398
- `build_type` - (Optional) The type of GitHub Pages site to build. Can be `legacy` or `workflow`. Defaults to `legacy`.
10499

105100
- `source` - (Optional) The source branch and directory for the rendered Pages site. Required when `build_type` is `legacy`. See [Source](#source) below for details.
106101

107102
- `cname` - (Optional) The custom domain for the repository.
108103

104+
- `public` - (Optional) Whether the GitHub Pages site is public.
105+
109106
### Source
110107

111108
The `source` block supports the following:
@@ -118,6 +115,8 @@ The `source` block supports the following:
118115

119116
In addition to the above arguments, the following attributes are exported:
120117

118+
- `repository_id` - The ID of the repository.
119+
121120
- `custom_404` - Whether the rendered GitHub Pages site has a custom 404 page.
122121

123122
- `html_url` - The absolute URL (with scheme) to the rendered GitHub Pages site.

0 commit comments

Comments
 (0)