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

Clearer documentation regarding tfe_workspace vcs_repo identifier arguement. #789

Closed
Hesse opened this issue Feb 4, 2023 · 0 comments · Fixed by #792
Closed

Clearer documentation regarding tfe_workspace vcs_repo identifier arguement. #789

Hesse opened this issue Feb 4, 2023 · 0 comments · Fixed by #792

Comments

@Hesse
Copy link

Hesse commented Feb 4, 2023

Use-cases

The documentation for the tfe_workspace here https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/resources/workspace#vcs_repo says the vcs_repo identifier argument should be in the format of <organization>/<repository> however that it isn't entirely clear if you mean the organization within TFC or in your VCS. It turned out to be the later. I recommend you make it clear that it's NOT the organization in TFC.

Attempted Solutions

Proposal

I propose that you explicitly state that the <organization> is not referring to the organization name in TFC but in your VCS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant