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

update advanced guides with warnings on when and how to use #1549

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

victoriaxyz
Copy link
Contributor

@victoriaxyz victoriaxyz commented Sep 18, 2024

Important

🔎 Previews:

Explanation:

This PR:

  • updates Clerk as IdP doc to make it extremely clear of the specific use case
  • updates warnings for satellite domains, proxies, and metadata docs

@victoriaxyz victoriaxyz requested a review from a team as a code owner September 18, 2024 19:22
@victoriaxyz victoriaxyz changed the title docs-9233: update advanced guides with warnings on when and how to use update advanced guides with warnings on when and how to use Sep 18, 2024
Copy link

Hey, here’s your docs preview: https://clerk.com/docs/pr/1549

![Clerk IDP Flow](/docs/images/advance/clerk-idp-flow.svg)
## When should you use Clerk as an OAuth provider?

You can use Clerk as an OAuth provider if you want your users to sign in to a third party site or a tool (e.g., Zapier or OpenAI) using their credentials from your application. **This is not the same as supporting an OAuth provider, such as Google, in your application. If you want your users to be able to sign in to your application with an OAuth provider, see [the dedicated guide](/docs/authentication/social-connections/oauth#configuration).**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small edit here - I'd be hesitant to recommend Zapier/OpenAI before we actually know it works with them though 😅

Suggested change
You can use Clerk as an OAuth provider if you want your users to sign in to a third party site or a tool (e.g., Zapier or OpenAI) using their credentials from your application. **This is not the same as supporting an OAuth provider, such as Google, in your application. If you want your users to be able to sign in to your application with an OAuth provider, see [the dedicated guide](/docs/authentication/social-connections/oauth#configuration).**
You can use Clerk as an OAuth provider if you want your users to sign in to a third party site or a tool (e.g., [Zapier](https://zapier.com/), [OpenAI](https://openai.com/), [Discourse](https://www.discourse.org/)) using their credentials from one of your existing Clerk applications. **This is not the same as supporting an OAuth provider, such as Google, in your application. If you want your users to be able to sign in to your application with an OAuth provider, see [the dedicated guide](/docs/authentication/social-connections/oauth#configuration).**

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenAI has worked for some customers, though I don't know the exact config they used. I am pretty sure Zapier has as well, but again I haven't tried. Maybe we use '3rd party tools' for the now until @jeremy-clerk has Zapier working and then mention it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the e.g. so the final sentence is You can use Clerk as an OAuth provider if you want your users to sign in to a third party site or a tool using their credentials from your application.

docs/advanced-usage/satellite-domains.mdx Show resolved Hide resolved
Copy link
Member

@royanger royanger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good

@alexisintech
Copy link
Member

thanks for the help on this one guys, writing this was hard but teamwork made this turn out great 🤝 @royanger @victoriaxyz

@victoriaxyz victoriaxyz merged commit 68233e4 into main Sep 19, 2024
4 checks passed
@victoriaxyz victoriaxyz deleted the vi/docs-9233/advanced-guides-warning branch September 19, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants