Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS]: Example usage in github_repository_collaborators doesn't match argument reference #1757

Closed
1 task done
commscheck opened this issue Jun 26, 2023 · 2 comments
Closed
1 task done
Labels
hacktoberfest Issues for participation in Hacktoberfest Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation

Comments

@commscheck
Copy link

Describe the need

Page in question: https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_collaborators

The "example usage" shows this:

resource "github_repository_collaborators" "a_repo_collaborators" {
  repository = github_repository.some_repo.name

  user {
    permission = "admin"
    username  = "SomeUser"  // (1)
  }

  team {
    permission = "pull"
    team_id = github_team.some_team.slug   // (2)
  }
}
  • The user block example (1) shows user.username, but the argument reference says it should be usernames. I think the example is correct for this one?
  • The team block example (2) shows team.team_id, but the argument reference says it should be team. Unsure which is correct (maybe team_id if I'm reading the source code correctly?.
  • The top-level user argument says "(Optional) List of uses" which has a typo, should be "users".

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@commscheck commscheck added Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation labels Jun 26, 2023
@kfcampbell kfcampbell added Status: Up for grabs Issues that are ready to be worked on by anyone Priority: Normal and removed Status: Triage This is being looked at and prioritized labels Jun 26, 2023
@kfcampbell
Copy link
Member

@commscheck do you have any interest in opening up a PR to fix this?

@nickfloyd nickfloyd added the hacktoberfest Issues for participation in Hacktoberfest label Sep 20, 2023
@Nmishin
Copy link
Contributor

Nmishin commented Jan 12, 2024

looks like it was resolved here: #1936

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Issues for participation in Hacktoberfest Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants