Merge pull request #12 from JacobASeverson/finish_docs

Finishing the website docs for the github provider for #11
hashicorp · Feb 18, 2016 · 506f2d5 · 506f2d5
2 parents 2fb76e9 + 8f3501c
commit 506f2d5
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 6 deletions.
diff --git a/website/source/docs/providers/github/r/membership.html.markdown b/website/source/docs/providers/github/r/membership.html.markdown
@@ -3,15 +3,15 @@ layout: "github"
 page_title: "Github: github_membership"
 sidebar_current: "docs-github-resource-membership"
 description: |-
-  Provides a Github organization membership resource.
+  Provides a Github membership resource.
 ---
 
 # github\_membership
 
-Provides a Github organization membership resource.
+Provides a Github membership resource.
 
 This resource allows you to add/remove users from your organization. When applied,
-the invitation will be sent to the user to become part of the organization. When
+an invitation will be sent to the user to become part of the organization. When
 destroyed, either the invitation will be cancelled or the user will be removed.
 
 ## Example Usage

diff --git a/website/source/docs/providers/github/r/team.html.markdown b/website/source/docs/providers/github/r/team.html.markdown
@@ -0,0 +1,37 @@
+---
+layout: "github"
+page_title: "Github: github_team"
+sidebar_current: "docs-github-resource-team"
+description: |-
+  Provides a Github team resource.
+---
+
+# github\_team
+
+Provides a Github team resource.
+
+This resource allows you to add/remove teams from your organization. When applied,
+a new team will be created. When destroyed, that team will be removed.
+
+## Example Usage
+
+```
+# Add a team to the organization
+resource "github_team" "some_team" {
+	name = "some-team"
+	description = "Some cool team"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `name` - (Required) The name of the team.
+* `description` - (Optional) A description of the team.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `id` - The ID of the created team.
diff --git a/website/source/docs/providers/github/r/team_membership.html.markdown b/website/source/docs/providers/github/r/team_membership.html.markdown
@@ -25,7 +25,7 @@ resource "github_membership" "membership_for_some_user" {
 }
 
 resource "github_team" "some_team" {
-	name = "SomeTeam"
+	name = "some-team"
 	description = "Some cool team"
 }
 

diff --git a/website/source/docs/providers/github/r/team_repository.html.markdown b/website/source/docs/providers/github/r/team_repository.html.markdown
@@ -18,7 +18,7 @@ the repository will be added to the team. When destroyed, the repository will be
 ```
 # Add a repository to the team
 resource "github_team" "some_team" {
-    name = "SomeTeam"
+    name = "some-team"
     description = "Some cool team"
 }
 
@@ -34,6 +34,8 @@ resource "github_team_repository" "some_team_repo" {
 The following arguments are supported:
 
 * `team_id` - (Required) The Github team id
-* `repository` - (Required) The repository to add to the team.
+
+* `repository` - (Required) The name of the repository to add to the team.
+
 * `permission` - (Optional) The permissions of team members regarding the repository. 
                   Must be one of `pull`, `push`, or `admin`. Defaults to `pull`.
diff --git a/website/source/layouts/github.erb b/website/source/layouts/github.erb
@@ -16,6 +16,9 @@
 					<li<%= sidebar_current("docs-github-resource-membership") %>>
 					<a href="/docs/providers/github/r/membership.html">github_membership</a>
 					</li>
+					<li<%= sidebar_current("docs-github-resource-team") %>>
+						<a href="/docs/providers/github/r/team.html">github_team</a>
+					</li>
 					<li<%= sidebar_current("docs-github-resource-team-membership") %>>
 						<a href="/docs/providers/github/r/team_membership.html">github_team_membership</a>
 					</li>