Skip to content

Commit 64272e4

Browse files
authored
website/docs: Correctly capitalize GitHub (#718)
- My editor also fixed some trailing whitespace.
1 parent 48af43e commit 64272e4

8 files changed

+28
-28
lines changed

website/docs/d/repository.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The following arguments are supported:
5555

5656
* `archived` - Whether the repository is archived.
5757

58-
* `pages` - The repository's GitHub Pages configuration.
58+
* `pages` - The repository's GitHub Pages configuration.
5959

6060
* `topics` - The list of topics of the repository.
6161

@@ -71,4 +71,4 @@ The following arguments are supported:
7171

7272
* `node_id` - GraphQL global node id for use with v4 API
7373

74-
* `repo_id` - Github ID for the repository
74+
* `repo_id` - GitHub ID for the repository

website/docs/r/actions_organization_secret.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This resource allows you to create and manage GitHub Actions secrets within your
1111
You must have write access to a repository to use this resource.
1212

1313
Secret values are encrypted using the [Go '/crypto/box' module](https://godoc.org/golang.org/x/crypto/nacl/box) which is
14-
interoperable with [libsodium](https://libsodium.gitbook.io/doc/). Libsodium is used by Github to decrypt secret values.
14+
interoperable with [libsodium](https://libsodium.gitbook.io/doc/). Libsodium is used by GitHub to decrypt secret values.
1515

1616
For the purposes of security, the contents of the `plaintext_value` field have been marked as `sensitive` to Terraform,
1717
but it is important to note that **this does not hide it from state files**. You should treat state as sensitive always.

website/docs/r/actions_secret.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This resource allows you to create and manage GitHub Actions secrets within your
1111
You must have write access to a repository to use this resource.
1212

1313
Secret values are encrypted using the [Go '/crypto/box' module](https://godoc.org/golang.org/x/crypto/nacl/box) which is
14-
interoperable with [libsodium](https://libsodium.gitbook.io/doc/). Libsodium is used by Github to decrypt secret values.
14+
interoperable with [libsodium](https://libsodium.gitbook.io/doc/). Libsodium is used by GitHub to decrypt secret values.
1515

1616
For the purposes of security, the contents of the `plaintext_value` field have been marked as `sensitive` to Terraform,
1717
but it is important to note that **this does not hide it from state files**. You should treat state as sensitive always.

website/docs/r/branch_protection.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The following arguments are supported:
9292
* `dismiss_stale_reviews`: (Optional) Dismiss approved reviews automatically when a new commit is pushed. Defaults to `false`.
9393
* `dismissal_restrictions`: (Optional) The list of actor IDs with dismissal access.
9494
* `require_code_owner_reviews`: (Optional) Require an approved review in pull requests including files with a designated code owner. Defaults to `false`.
95-
* `required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches Github's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
95+
* `required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches GitHub's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
9696

9797

9898
## Import

website/docs/r/branch_protection_v3.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: |-
77

88
# github\_branch\_protection
99

10-
Protects a GitHub branch.
10+
Protects a GitHub branch.
1111

1212
The `github_branch_protection` resource has moved to the GraphQL API, while this resource will continue to leverage the REST API.
1313

@@ -93,7 +93,7 @@ The following arguments are supported:
9393
* `dismissal_teams`: (Optional) The list of team slugs with dismissal access.
9494
Always use `slug` of the team, **not** its name. Each team already **has** to have access to the repository.
9595
* `require_code_owner_reviews`: (Optional) Require an approved review in pull requests including files with a designated code owner. Defaults to `false`.
96-
* `required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches Github's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
96+
* `required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches GitHub's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
9797

9898
### Restrictions
9999

website/docs/r/repository.html.markdown

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ resource "github_repository" "example" {
2626
}
2727
```
2828

29-
## Example Usage with Github Pages Enabled
29+
## Example Usage with GitHub Pages Enabled
3030

3131
```hcl
3232
resource "github_repository" "example" {
@@ -56,7 +56,7 @@ The following arguments are supported:
5656

5757
* `private` - (Optional) Set to `true` to create a private repository.
5858
Repositories are created as public (e.g. open source) by default.
59-
59+
6060
* `visibility` - (Optional) Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be `internal`. The `visibility` parameter overrides the `private` parameter.
6161

6262
* `has_issues` - (Optional) Set to `true` to enable the GitHub Issues features
@@ -66,7 +66,7 @@ The following arguments are supported:
6666

6767
* `has_wiki` - (Optional) Set to `true` to enable the GitHub Wiki features on
6868
the repository.
69-
69+
7070
* `is_template` - (Optional) Set to `true` to tell GitHub that this is a template repository.
7171

7272
* `allow_merge_commit` - (Optional) Set to `false` to disable merge commits on the repository.
@@ -93,23 +93,23 @@ initial repository creation and create the target branch inside of the repositor
9393

9494
* `archive_on_destroy` - (Optional) Set to `true` to archive the repository instead of deleting on destroy.
9595

96-
* `pages` - (Optional) The repository's Github Pages configuration. See [Github Pages Configuration](#github-pages-configuration) below for details.
96+
* `pages` - (Optional) The repository's GitHub Pages configuration. See [GitHub Pages Configuration](#github-pages-configuration) below for details.
9797

9898
* `topics` - (Optional) The list of topics of the repository.
9999

100100
* `template` - (Optional) Use a template repository to create this resource. See [Template Repositories](#template-repositories) below for details.
101101

102-
* `vulnerability_alerts` (Optional) - Set to `true` to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on public repos but disables them on private repos by default.) See [GitHub Documentation](https://help.github.com/en/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies) for details.
102+
* `vulnerability_alerts` (Optional) - Set to `true` to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on public repos but disables them on private repos by default.) See [GitHub Documentation](https://help.github.com/en/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies) for details.
103103

104-
### Github Pages Configuration
104+
### GitHub Pages Configuration
105105

106106
The `pages` block supports the following:
107107

108-
* `source` - (Required) The source branch and directory for the rendered Pages site. See [Github Pages Source](#github-pages-source) below for details.
108+
* `source` - (Required) The source branch and directory for the rendered Pages site. See [GitHub Pages Source](#github-pages-source) below for details.
109109

110110
* `cname` - (Optional) The custom domain for the repository. This can only be set after the repository has been created.
111111

112-
#### Github Pages Source ####
112+
#### GitHub Pages Source ####
113113

114114
The `source` block supports the following:
115115

@@ -144,12 +144,12 @@ The following additional attributes are exported:
144144

145145
* `node_id` - GraphQL global node id for use with v4 API
146146

147-
* `repo_id` - Github ID for the repository
147+
* `repo_id` - GitHub ID for the repository
148148

149-
* `pages` - The block consisting of the repository's Github Pages configuration with the following additional attributes:
150-
* `custom_404` - Whether the rendered Github Pages site has a custom 404 page.
151-
* `html_url` - The absolute URL (including scheme) of the rendered Github Pages site e.g. `https://username.github.io`.
152-
* `status` - The Github Pages site's build status e.g. `building` or `built`.
149+
* `pages` - The block consisting of the repository's GitHub Pages configuration with the following additional attributes:
150+
* `custom_404` - Whether the rendered GitHub Pages site has a custom 404 page.
151+
* `html_url` - The absolute URL (including scheme) of the rendered GitHub Pages site e.g. `https://username.github.io`.
152+
* `status` - The GitHub Pages site's build status e.g. `building` or `built`.
153153

154154
## Import
155155

website/docs/r/repository_milestone.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: |-
99

1010
Provides a GitHub repository milestone resource.
1111

12-
This resource allows you to create and manage milestones for a Github Repository within an organization or user account.
12+
This resource allows you to create and manage milestones for a GitHub Repository within an organization or user account.
1313

1414
## Example Usage
1515

@@ -26,9 +26,9 @@ resource "github_repository_milestone" "example" {
2626

2727
The following arguments are supported:
2828

29-
* `owner` - (Required) The owner of the Github Repository.
29+
* `owner` - (Required) The owner of the GitHub Repository.
3030

31-
* `repository` - (Required) The name of the Github Repository.
31+
* `repository` - (Required) The name of the GitHub Repository.
3232

3333
* `title` - (Required) The title of the milestone.
3434

website/docs/r/team_sync_group_mapping.html.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010
This resource allows you to create and manage Identity Provider (IdP) group connections within your GitHub teams.
1111
You must have team synchronization enabled for organizations owned by enterprise accounts.
1212

13-
To learn more about team synchronization between IdPs and Github, please refer to:
13+
To learn more about team synchronization between IdPs and GitHub, please refer to:
1414
https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github
1515

1616
## Example Usage
@@ -21,15 +21,15 @@ data "github_organization_team_sync_groups" "example_groups" {}
2121
2222
resource "github_team_sync_group_mapping" "example_group_mapping" {
2323
team_slug = "example"
24-
24+
2525
dynamic "group" {
2626
for_each = [for g in data.github_organization_team_sync_groups.example_groups.groups : g if g.group_name == "some_team_group"]
2727
content {
2828
group_id = group.value.group_id
2929
group_name = group.value.group_name
3030
group_description = group.value.group_description
3131
}
32-
}
32+
}
3333
}
3434
```
3535

@@ -45,7 +45,7 @@ The `group` block consists of:
4545

4646
* `group_id` - The ID of the IdP group.
4747

48-
* `group_name` - The name of the IdP group.
48+
* `group_name` - The name of the IdP group.
4949

5050
* `group_description` - The description of the IdP group.
5151

@@ -55,4 +55,4 @@ GitHub Team Sync Group Mappings can be imported using the GitHub team `slug` e.g
5555

5656
```
5757
$ terraform import github_team_sync_group_mapping.example some_team
58-
```
58+
```

0 commit comments

Comments
 (0)