update documentation for github_team_members to recommended team id #1991
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kfcampbell
approved these changes
Nov 7, 2023
avidspartan1
pushed a commit
to avidspartan1/terraform-provider-github
that referenced
this pull request
Feb 5, 2024
…ntegrations#1991) Co-authored-by: Keegan Campbell <me@kfcampbell.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1964
The issue seemed difficult to correct via code. It seems better to still allow the current behaviour but recommend the desired approach.
Before the change?
Documentation did not describe the pitfalls of using the team slug when creating or importing the
github_team_membersresource.After the change?
Documentation recommends that the team id, rather than team slug, is used for the
github_team_membersresource and gives the reasons why.Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!