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

Add Waitlist guide; add setup instructions to waitlist component reference #1734

Merged
merged 13 commits into from
Nov 25, 2024

Conversation

alexisintech
Copy link
Member

@alexisintech alexisintech commented Nov 21, 2024

Explanation:

  • The instructions on how to set up the waitlist component was not clear.

This PR:

  • Adds a guide for setting up an app with a waitlist
  • Component reference: Adds instructions for enabling Waitlist mode in the Clerk Dashboard and adds warning callout that the user must configure ClerkProvider before using the waitlist component
  • Changes the URL for the component reference: /docs/components/waitlist/overview --> /docs/components/waitlist

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • I have added the "deploy-preview" label and added the preview link(s) to this PR description
  • All existing checks pass

@alexisintech alexisintech requested a review from a team as a code owner November 21, 2024 19:32
Copy link

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

Before using the `<Waitlist />` component, you must enable **Waitlist** mode in the Clerk Dashboard:

1. In the Clerk Dashboard, navigate to the [**Restrictions**](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions) page.
1. Under the **Sign-up modes** section, enable **Waitlist**.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: This action should be Select since it's a radio button.

@alexisintech alexisintech changed the title Add setup instructions to waitlist component reference Add Waitlist guide; add setup instructions to waitlist component reference Nov 21, 2024

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<ClerkProvider waitlistUrl="/waitlist">
Copy link
Member

Choose a reason for hiding this comment

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

@alexisintech I saw that you render the <Waitlist /> component in /, so the waitlistUrl prop should be /

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed! a93f692

import { SignIn } from '@clerk/nextjs'

export default function Page() {
return <SignIn waitlistUrl="/" />
Copy link
Member

Choose a reason for hiding this comment

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

If we pass the waitlistUrl in <ClerkProvider> we don't need to add it here

Copy link
Member Author

Choose a reason for hiding this comment

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

addressed: a93f692

@alexisintech
Copy link
Member Author

blocked until redirects are merged: https://github.com/clerk/clerk/pull/811

@alexisintech alexisintech merged commit 0eea657 into main Nov 25, 2024
5 checks passed
@alexisintech alexisintech deleted the aa/DOCS-9598 branch November 25, 2024 16:34
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.

3 participants