Skip to content

Commit 89ef665

Browse files
authored
Initial commit of adding org owner team membership doc notes (#1467)
1 parent dba0745 commit 89ef665

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

website/docs/r/team_members.html.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ When applied, if the user hasn't accepted their invitation to the organization,
1515

1616
When destroyed, all users will be removed from the team.
1717

18-
~> **Note**: This resource is not compatible with `github_team_membership`. Use either `github_team_members` or `github_team_membership`.
18+
~> **Note** This resource is not compatible with `github_team_membership`. Use either `github_team_members` or `github_team_membership`.
1919

20-
~> **Note**: You can accidentally lock yourself out of your team using this resource. Deleting a `github_team_members` resource removes access from anyone without organization-level access to the team. Proceed with caution. It should generally only be used with teams fully managed by Terraform.
20+
~> **Note** You can accidentally lock yourself out of your team using this resource. Deleting a `github_team_members` resource removes access from anyone without organization-level access to the team. Proceed with caution. It should generally only be used with teams fully managed by Terraform.
21+
22+
~> **Note** Attempting to set a user who is an organization owner to "member" will result in the user being granted "maintainer" instead; this can result in a perpetual `terraform plan` diff that changes their status back to "member".
2123

2224
## Example Usage
2325

website/docs/r/team_membership.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ the user will be added to the team. If the user hasn't accepted their invitation
1414
organization, they won't be part of the team until they do. When
1515
destroyed, the user will be removed from the team.
1616

17-
~> **Note**: This resource is not compatible with `github_team_members`. Use either `github_team_members` or `github_team_membership`.
17+
~> **Note** This resource is not compatible with `github_team_members`. Use either `github_team_members` or `github_team_membership`.
18+
19+
~> **Note** Organization owners may not be set as "members" of a team; they may only be set as "maintainers". Attempting to set organization an owner to "member" of a may result in a `terraform plan` diff that changes their status back to "maintainer".
1820

1921
## Example Usage
2022

0 commit comments

Comments
 (0)