Skip to content

Commit 7eb9175

Browse files
phinzephinze
committed
Merge pull request hashicorp#6063 from hashicorp/sethvargo/github
Capitalize the H in GitHub
2 parents 662dc9f + 4fde3b2 commit 7eb9175

7 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎website/source/docs/providers/github/index.html.markdown‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
layout: "github"
3-
page_title: "Provider: Github"
3+
page_title: "Provider: GitHub"
44
sidebar_current: "docs-github-index"
55
description: |-
6-
The Github provider is used to interact with Github organization resources.
6+
The GitHub provider is used to interact with GitHub organization resources.
77
---
88

9-
# Github Provider
9+
# GitHub Provider
1010

11-
The Github provider is used to interact with Github organization resources.
11+
The GitHub provider is used to interact with GitHub organization resources.
1212

13-
The provider allows you to manage your Github organization's members and teams easily.
13+
The provider allows you to manage your GitHub organization's members and teams easily.
1414
It needs to be configured with the proper credentials before it can be used.
1515

1616
Use the navigation to the left to read about the available resources.
1717

1818
## Example Usage
1919

2020
```
21-
# Configure the Github Provider
21+
# Configure the GitHub Provider
2222
provider "github" {
2323
token = "${var.github_token}"
2424
organization = "${var.github_organization}"
@@ -34,9 +34,9 @@ resource "github_membership" "membership_for_user_x" {
3434

3535
The following arguments are supported in the `provider` block:
3636

37-
* `token` - (Optional) This is the Github personal access token. It must be provided, but
37+
* `token` - (Optional) This is the GitHub personal access token. It must be provided, but
3838
it can also be sourced from the `GITHUB_TOKEN` environment variable.
3939

40-
* `organization` - (Optional) This is the target Github organization to manage. The account
40+
* `organization` - (Optional) This is the target GitHub organization to manage. The account
4141
corresponding to the token will need "owner" privileges for this organization. It must be provided, but
4242
it can also be sourced from the `GITHUB_ORGANIZATION` environment variable.

‎website/source/docs/providers/github/r/membership.html.markdown‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: "github"
3-
page_title: "Github: github_membership"
3+
page_title: "GitHub: github_membership"
44
sidebar_current: "docs-github-resource-membership"
55
description: |-
6-
Provides a Github membership resource.
6+
Provides a GitHub membership resource.
77
---
88

99
# github\_membership
1010

11-
Provides a Github membership resource.
11+
Provides a GitHub membership resource.
1212

1313
This resource allows you to add/remove users from your organization. When applied,
1414
an invitation will be sent to the user to become part of the organization. When

‎website/source/docs/providers/github/r/team.html.markdown‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: "github"
3-
page_title: "Github: github_team"
3+
page_title: "GitHub: github_team"
44
sidebar_current: "docs-github-resource-team"
55
description: |-
6-
Provides a Github team resource.
6+
Provides a GitHub team resource.
77
---
88

99
# github\_team
1010

11-
Provides a Github team resource.
11+
Provides a GitHub team resource.
1212

1313
This resource allows you to add/remove teams from your organization. When applied,
1414
a new team will be created. When destroyed, that team will be removed.

‎website/source/docs/providers/github/r/team_membership.html.markdown‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: "github"
3-
page_title: "Github: github_team_membership"
3+
page_title: "GitHub: github_team_membership"
44
sidebar_current: "docs-github-resource-team-membership"
55
description: |-
6-
Provides a Github team membership resource.
6+
Provides a GitHub team membership resource.
77
---
88

99
# github\_team_membership
1010

11-
Provides a Github team membership resource.
11+
Provides a GitHub team membership resource.
1212

1313
This resource allows you to add/remove users from teams in your organization. When applied,
1414
the user will be added to the team. If the user hasn't accepted their invitation to the
@@ -40,7 +40,7 @@ resource "github_team_membership" "some_team_membership" {
4040

4141
The following arguments are supported:
4242

43-
* `team_id` - (Required) The Github team id
43+
* `team_id` - (Required) The GitHub team id
4444
* `username` - (Required) The user to add to the team.
4545
* `role` - (Optional) The role of the user within the team.
4646
Must be one of `member` or `maintainer`. Defaults to `member`.

‎website/source/docs/providers/github/r/team_repository.html.markdown‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: "github"
3-
page_title: "Github: github_team_repository"
3+
page_title: "GitHub: github_team_repository"
44
sidebar_current: "docs-github-resource-team-repository"
55
description: |-
6-
Provides a Github team repository resource.
6+
Provides a GitHub team repository resource.
77
---
88

99
# github\_team_repository
1010

11-
Provides a Github team repository resource.
11+
Provides a GitHub team repository resource.
1212

1313
This resource allows you to add/remove repositories from teams in your organization. When applied,
1414
the repository will be added to the team. When destroyed, the repository will be removed from the team.
@@ -33,7 +33,7 @@ resource "github_team_repository" "some_team_repo" {
3333

3434
The following arguments are supported:
3535

36-
* `team_id` - (Required) The Github team id
36+
* `team_id` - (Required) The GitHub team id
3737
* `repository` - (Required) The repository to add to the team.
3838
* `permission` - (Optional) The permissions of team members regarding the repository.
3939
Must be one of `pull`, `push`, or `admin`. Defaults to `pull`.

‎website/source/layouts/docs.erb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@
194194
</li>
195195

196196
<li<%= sidebar_current("docs-providers-github") %>>
197-
<a href="/docs/providers/github/index.html">Github</a>
197+
<a href="/docs/providers/github/index.html">GitHub</a>
198198
</li>
199199

200200
<li<%= sidebar_current("docs-providers-fastly") %>>

‎website/source/layouts/github.erb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</li>
88

99
<li<%= sidebar_current("docs-github-index") %>>
10-
<a href="/docs/providers/github/index.html">Github Provider</a>
10+
<a href="/docs/providers/github/index.html">GitHub Provider</a>
1111
</li>
1212

1313
<li<%= sidebar_current(/^docs-github-resource/) %>>

0 commit comments

Comments
 (0)