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

Document coder_git_auth deprecation #203

Open
evilhamsterman opened this issue Apr 1, 2024 · 0 comments
Open

Document coder_git_auth deprecation #203

evilhamsterman opened this issue Apr 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@evilhamsterman
Copy link

In #163 coder_git_auth was marked as deprecated. It does show a message when used but it would be helpful to provide that same information in the documentation. Right now the documentation doesn't say anything about the deprecated state of coder_git_auth or mentions you should use coder_external_auth instead.

In fact because of the fact that the coder_external_auth mentions multiple services but not anything like git or GitHub (gh is mentioned but unless you know it you may not make the connection) people may be lead to believe they should use coder_git_auth for git authentication and coder_external_auth for authentication with other services. This may lead people to use one and not realize the deprecation until they first use it in a template. Unless like me they go looking for what the difference is and stumble on the PR.

@coder-labeler coder-labeler bot added the documentation Improvements or additions to documentation label Apr 1, 2024
@matifali matifali added the good first issue Good for newcomers label Apr 15, 2024
kyle-pazdel added a commit to kyle-pazdel/terraform-provider-coder that referenced this issue Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants