Skip to content

Commit fd54e80

Browse files
Minor - Add missing doc for github_enterprise_organization and fix typos (#1511)
Co-authored-by: Keegan Campbell <me@kfcampbell.com>
1 parent b524689 commit fd54e80

File tree

3 files changed

+53
-6
lines changed

3 files changed

+53
-6
lines changed

website/docs/d/enterprise.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Use this data source to retrieve basic information about a GitHub enterprise.
1212
## Example Usage
1313

1414
```
15-
data "github_enteprise" "example" {
15+
data "github_enterprise" "example" {
1616
slug = "example-co"
1717
}
1818
```
@@ -21,7 +21,7 @@ data "github_enteprise" "example" {
2121

2222
* `id` - The ID of the enterprise.
2323
* `slug` - The URL slug identifying the enterprise.
24-
* `name` - The name of the enteprise.
25-
* `description` - The description of the enterpise.
24+
* `name` - The name of the enterprise.
25+
* `description` - The description of the enterprise.
2626
* `created_at` - The time the enterprise was created.
2727
* `url` - The url for the enterprise.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: "github"
3+
page_title: "Github: github_enterprise_organization"
4+
description: |-
5+
Create and manages a GitHub enterprise organization.
6+
---
7+
8+
# github_enterprise_organization
9+
10+
This resource allows you to create and manage a GitHub enterprise organization.
11+
12+
~> **Note** This resource cannot delete an organization. Organizations must be deleted through the GitHub UI and remove them from the state using `terraform state rm`.
13+
14+
## Example Usage
15+
16+
```
17+
resource "github_enterprise_organization" "org" {
18+
enterprise_id = data.github_enterprise.enterprise.id
19+
name = "some-awesome-org"
20+
description = "Organization created with terraform"
21+
billing_email = "jon@winteriscoming.com"
22+
admin_logins = [
23+
"jon-snow"
24+
]
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
* `enterprise_id` - (Required) The ID of the enterprise.
31+
* `name` - (Required) The name of the organization.
32+
* `description` - (Optional) The description of the organization.
33+
* `billing_email` - (Required) The billing email address.
34+
* `admin_logins` - (Required) List of organization owner usernames.
35+
36+
## Attributes Reference
37+
38+
The following additional attributes are exported:
39+
40+
* `id` - The ID of the organization.
41+
42+
## Import
43+
44+
Support for importing organizations is not currently supported.

website/github.erb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@
4949
<li>
5050
<a href="/docs/providers/github/d/dependabot_secrets.html">dependabot_secrets</a>
5151
</li>
52-
<li>
53-
<a href="/docs/providers/github/d/enterprise.html">github_enteprise</a>
54-
</li>
52+
<li>
53+
<a href="/docs/providers/github/d/enterprise.html">github_enterprise</a>
54+
</li>
5555
<li>
5656
<a href="/docs/providers/github/d/external_groups.html">github_external_groups</a>
5757
</li>
@@ -166,6 +166,9 @@
166166
<li>
167167
<a href="/docs/providers/github/r/branch_protection_v3.html">github_branch_protection_v3</a>
168168
</li>
169+
<li>
170+
<a href="/docs/providers/github/r/enterprise_organization.html">github_enterprise_organization</a>
171+
</li>
169172
<li>
170173
<a href="/docs/providers/github/r/issue.html">github_issue</a>
171174
</li>

0 commit comments

Comments
 (0)