Skip to content

Commit

Permalink
remove please
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech committed Nov 18, 2024
1 parent 6099506 commit 206821d
Show file tree
Hide file tree
Showing 22 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/authentication/saml/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Yes, Clerk supports both Service Provider-initiated (SP-initiated) and Identity

### How much does it cost?

For production instances, each active connection costs $50 per month. SAML connections require the Pro plan and the Enhanced Authentication Add-on. Please see [pricing](/pricing){{ target: '_blank' }} for those costs, and the costs of other add-ons or features.
For production instances, each active connection costs $50 per month. SAML connections require the Pro plan and the Enhanced Authentication Add-on. See [pricing](/pricing){{ target: '_blank' }} for those costs, and the costs of other add-ons or features.

For development instances, SAML connections will always be free, but capped to 5.

Expand Down
6 changes: 3 additions & 3 deletions docs/components/control/redirect-to-createorganization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The `<RedirectToCreateOrganization />` component will navigate to the create org
<SignedIn>
<RedirectToCreateOrganization />
</SignedIn>
<SignedOut>Please Sign In</SignedOut>
<SignedOut>Sign In</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -43,7 +43,7 @@ The `<RedirectToCreateOrganization />` component will navigate to the create org
<SignedIn>
<RedirectToCreateOrganization />
</SignedIn>
<SignedOut>Please Sign In</SignedOut>
<SignedOut>Sign In</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -61,7 +61,7 @@ The `<RedirectToCreateOrganization />` component will navigate to the create org
<RedirectToCreateOrganization />
</SignedIn>
<SignedOut>
<p>Please sign in </p>
<p>Sign in </p>
</SignedOut>
</div>
)
Expand Down
6 changes: 3 additions & 3 deletions docs/components/control/redirect-to-organizationprofile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The `<RedirectToOrganizationProfile />` component will navigate to the organizat
<SignedIn>
<RedirectToOrganizationProfile />
</SignedIn>
<SignedOut>Please Sign In</SignedOut>
<SignedOut>Sign In</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -43,7 +43,7 @@ The `<RedirectToOrganizationProfile />` component will navigate to the organizat
<SignedIn>
<RedirectToOrganizationProfile />
</SignedIn>
<SignedOut>Please Sign In</SignedOut>
<SignedOut>Sign In</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -61,7 +61,7 @@ The `<RedirectToOrganizationProfile />` component will navigate to the organizat
<RedirectToOrganizationProfile />
</SignedIn>
<SignedOut>
<p>Please sign in </p>
<p>Sign in </p>
</SignedOut>
</div>
)
Expand Down
6 changes: 3 additions & 3 deletions docs/components/control/redirect-to-userprofile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To find your User Profile URL:
<SignedIn>
<RedirectToUserProfile />
</SignedIn>
<SignedOut>Please Sign In</SignedOut>
<SignedOut>Sign In</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -44,7 +44,7 @@ To find your User Profile URL:
<SignedIn>
<RedirectToUserProfile />
</SignedIn>
<SignedOut>Please Sign In</SignedOut>
<SignedOut>Sign In</SignedOut>
</ClerkProvider>
)
}
Expand All @@ -62,7 +62,7 @@ To find your User Profile URL:
<RedirectToUserProfile />
</SignedIn>
<SignedOut>
<p>Please sign in </p>
<p>Sign in </p>
</SignedOut>
</div>
)
Expand Down
2 changes: 1 addition & 1 deletion docs/custom-flows/forgot-password.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ For the sake of this guide, this example is written for Next.js App Router but i
>
{!successfulCreation && (
<>
<label htmlFor="email">Please provide your email address</label>
<label htmlFor="email">Provide your email address</label>
<input
type="email"
placeholder="e.g [email protected]"
Expand Down
2 changes: 1 addition & 1 deletion docs/customization/elements/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn how to use Clerk Elements to build custom UIs on top of the C
> [!WARNING]
> Clerk Elements is currently in beta with support for Next.js App Router. It is **not yet recommended for production use**.
>
> If you have any feedback, please reach out to [[email protected]](mailto:[email protected]) or head over to the [GitHub Discussion](https://github.com/orgs/clerk/discussions/3315).
> If you have any feedback, contact [[email protected]](mailto:[email protected]) or head over to the [GitHub Discussion](https://github.com/orgs/clerk/discussions/3315).
Clerk Elements is a library of unstyled, composable components that can be used to build custom UIs on top of the Clerk APIs without having to manage the underlying logic.

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/webhooks/debug-your-webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The following table has some of the common response codes you might see and what
| `401` | The request was not authorized. If your test in the [Test the Route Handler or API Route](#test-the-route-handler-or-api-route) section worked, you should not see this error. If you are seeing it, then you will need to configure your Middleware to accept the request. |
| `404` | The URL for the webhook was not found. Check that your application is running and that [the endpoint is correct in the Clerk Dashboard](/docs/integrations/webhooks/debug-your-webhooks#check-your-configuration-in-the-clerk-dashboard). |
| `405` | Your route is not accepting a `POST` request. All webhooks are `POST` requests and the route must accept them. Unless you are using the route for something else, you can restrict the route to `POST` requests only. |
| `500` | The request made it to your application, but there is a code-related issue. This is likely a webhook verification issue or something in the webhook logic. Please see the following sections. |
| `500` | The request made it to your application, but there is a code-related issue. This is likely a webhook verification issue or something in the webhook logic. See the following sections. |

## Debug webhook verification

Expand Down
2 changes: 1 addition & 1 deletion docs/references/backend/types/backend-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The Backend `User` object is similar to the `User` object as it holds informatio
- `unsafeMetadata`
- `{[string]: any}`

Metadata that can be read and set from the Frontend API. One common use case for this attribute is to implement custom fields that will be attached to the `User` object.<br />Please note that there is also an `unsafeMetadata` attribute in the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object. The value of that field will be automatically copied to the user's unsafe metadata once the sign up is complete.
Metadata that can be read and set from the Frontend API. One common use case for this attribute is to implement custom fields that will be attached to the `User` object.<br />There is also an `unsafeMetadata` attribute in the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object. The value of that field will be automatically copied to the user's unsafe metadata once the sign up is complete.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/references/backend/user/create-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,14 +162,14 @@ function createUser(params: CreateUserParams): Promise<User>
- `skipPasswordRequirement?`
- `boolean`

When set to `true`, password is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance.
When set to `true`, password is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. You cannot use this flag if password is the only way for a user to sign into your instance.

---

- `totpSecret?`
- `string`

In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. Please note that currently the supported options are: <ul><li>Period: 30 seconds</li><li>Code length: 6 digits</li><li>Algorithm: SHA1</li></ul>
In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. Currently, the supported options are: <ul><li>Period: 30 seconds</li><li>Code length: 6 digits</li><li>Algorithm: SHA1</li></ul>

---

Expand Down
4 changes: 2 additions & 2 deletions docs/references/backend/user/update-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ function updateUser(userId: string, params: UpdateUserParams): Promise<User>
- `skipPasswordRequirement?`
- `boolean`

When set to `true`, password is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance.
When set to `true`, password is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. You cannot use this flag if password is the only way for a user to sign into your instance.

---

Expand All @@ -133,7 +133,7 @@ function updateUser(userId: string, params: UpdateUserParams): Promise<User>
- `totpSecret?`
- `string`

In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. Please note that currently the supported options are: <ul><li>Period: 30 seconds</li><li>Code length: 6 digits</li><li>Algorithm: SHA1</li></ul>
In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. Currently, the supported options are: <ul><li>Period: 30 seconds</li><li>Code length: 6 digits</li><li>Algorithm: SHA1</li></ul>

---

Expand Down
2 changes: 1 addition & 1 deletion docs/references/javascript/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ While we typically recommend using one of our framework SDK's, such as [Clerk Re

## Installation

Please follow the instructions in the [ClerkJS quickstart](/docs/quickstarts/javascript) to add ClerkJS to your project.
Follow the instructions in the [ClerkJS quickstart](/docs/quickstarts/javascript) to add ClerkJS to your project.

## Usage

Expand Down
14 changes: 7 additions & 7 deletions docs/references/javascript/sign-up/sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -167,42 +167,42 @@ function create(params: SignUpCreateParams): Promise<SignUpResource>
- `firstName`
- `string | null`

The user's first name. This option is available only if name is selected in personal information. Please check the instance settings for more information.
The user's first name. This option is available only if name is selected in personal information. Check the instance settings for more information.

---

- `lastName`
- `string | null`

The user's last name. This option is available only if name is selected in personal information. Please check the instance settings for more information.
The user's last name. This option is available only if name is selected in personal information. Check the instance settings for more information.

---

- `password`
- `string | null`

The user's password. This option is available only if password-based authentication is selected. Please check the instance settings for more information.
The user's password. This option is available only if password-based authentication is selected. Check the instance settings for more information.

---

- `gender`
- `string | null`

The user's gender. This option is available only if gender is selected in personal information. Please check the instance settings for more information.
The user's gender. This option is available only if gender is selected in personal information. Check the instance settings for more information.

---

- `emailAddress`
- `string | null`

The user's email address. This option is available only if email address is selected in contact information. Keep in mind that the email address requires an extra verification process. Please check the instance settings for more information.
The user's email address. This option is available only if email address is selected in contact information. Keep in mind that the email address requires an extra verification process. Check the instance settings for more information.

---

- `phoneNumber`
- `string | null`

The user's phone number. This option is available only if phone number is selected in contact information. Keep in mind that the phone number requires an extra verification process. Please check the instance settings for more information.
The user's phone number. This option is available only if phone number is selected in contact information. Keep in mind that the phone number requires an extra verification process. Check the instance settings for more information.

---

Expand All @@ -216,7 +216,7 @@ function create(params: SignUpCreateParams): Promise<SignUpResource>
- `username`
- `string | null`

The user's username. This option is available only if usernames are enabled. Please check the instance settings for more information.
The user's username. This option is available only if usernames are enabled. Check the instance settings for more information.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/references/javascript/user/user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to
- `unsafeMetadata`
- `{[string]: any} | null`

Metadata that can be read and set from the Frontend API. One common use case for this attribute is to implement custom fields that will be attached to the `User` object.<br />Please note that there is also an `unsafeMetadata` attribute in the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object. The value of that field will be automatically copied to the user's unsafe metadata once the sign up is complete.
Metadata that can be read and set from the Frontend API. One common use case for this attribute is to implement custom fields that will be attached to the `User` object.<br />There is also an `unsafeMetadata` attribute in the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object. The value of that field will be automatically copied to the user's unsafe metadata once the sign up is complete.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/references/nextjs/read-session-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Under the hood, `currentUser()` uses the [`clerkClient`](/docs/references/backen
You can access the active session and user data in your `getServerSideProps` using the `getAuth()` helper.

> [!NOTE]
> Please note the addition of `buildClerkProps` in the return statement, which informs the Clerk React helpers of the authentication state during server-side rendering (like `useAuth()`, `<SignedIn>`, and `<SignedOut>`).
> Note the addition of `buildClerkProps` in the return statement, which informs the Clerk React helpers of the authentication state during server-side rendering (like `useAuth()`, `<SignedIn>`, and `<SignedOut>`).
```tsx {{ filename: 'pages/example.tsx' }}
import { getAuth, buildClerkProps } from '@clerk/nextjs/server'
Expand Down
2 changes: 1 addition & 1 deletion docs/references/sdk/conventions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ Your SDK will require your users to have Node.js installed and use the framework

Security is important at Clerk and thus all Clerk SDKs are published with provenance statements. This allows you to publicly establish where a package was built and who published a package, which can increase supply-chain security for your packages.

Please read npm's guide on [generating provenance statements](https://docs.npmjs.com/generating-provenance-statements).
Read npm's guide on [generating provenance statements](https://docs.npmjs.com/generating-provenance-statements).
2 changes: 1 addition & 1 deletion docs/security/vulnerability-disclosure-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In the interest of the safety of our users, staff, the Internet at large and you

## How to report a security vulnerability

If you believe you've found a security vulnerability in one of our products or platforms send it to us by emailing [[email protected]](mailto:[email protected]). Please include the following details with your report:
If you believe you've found a security vulnerability in one of our products or platforms send it to us by emailing [[email protected]](mailto:[email protected]). Include the following details with your report:

Description of the location and potential impact of the vulnerability; and
A detailed description of the steps required to reproduce the vulnerability (POC scripts, screenshots, and compressed screen captures are all helpful to us).
2 changes: 1 addition & 1 deletion docs/upgrade-guides/core-2/backend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Some top level import paths have been changed in order to improve tree-shaking a
</AccordionPanel>

<AccordionPanel>
The `createIsomorphicRequest` import was intended for those building custom Clerk integrations for frameworks and has been moved to `@clerk/backend/internal` to reflect this. Please use caution when using internal imports as they are outside the bounds of semver.
The `createIsomorphicRequest` import was intended for those building custom Clerk integrations for frameworks and has been moved to `@clerk/backend/internal` to reflect this. Use caution when using internal imports as they are outside the bounds of semver.

```js {{ del: [1], ins: [2] }}
import { createIsomorphicRequest } from '@clerk/backend'
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guides/core-2/nextjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ As part of this release, some of the top-level exports of `@clerk/nextjs` have b
import { } from '@clerk/nextjs'
```

Some behavior may have changed between Clerk's beta and the stable release. Please check on your end if behavior stayed the same.
Some behavior may have changed between Clerk's beta and the stable release. Check on your end if behavior stayed the same.
</AccordionPanel>

<AccordionPanel>
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guides/core-2/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In April 2024, we updated Clerk's SDKs to include Core 2. This new core includes
## SDK Guides

Core 2 brings both UI changes and breaking code changes, so each SDK has been updated to a new major version.
We expect upgrades to take less than 30 minutes, and are providing a CLI tool to assist with the process. Please select your SDK below to get started:
We expect upgrades to take less than 30 minutes, and are providing a CLI tool to assist with the process. Select your SDK below to get started:

- [Next.js](/docs/upgrade-guides/core-2/nextjs)
- [Remix](/docs/upgrade-guides/core-2/remix)
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guides/core-2/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ As part of this major version, a number of previously deprecated props, argument
</AccordionPanel>

<AccordionPanel>
`MultiSessionAppSupport` is a component that handles the intermediate “undefined” state for multisession apps by unmounting and remounting the components during the session switch (`setActive` call) in order to solve theoretical edge-cases that can arise while switching sessions. It is undocumented and intended only for internal use, so it has been moved to an `/internal` import path. Please note that internal imports are not intended for public use, and are outside the scope of semver.
`MultiSessionAppSupport` is a component that handles the intermediate “undefined” state for multisession apps by unmounting and remounting the components during the session switch (`setActive` call) in order to solve theoretical edge-cases that can arise while switching sessions. It is undocumented and intended only for internal use, so it has been moved to an `/internal` import path. Note that internal imports are not intended for public use, and are outside the scope of semver.

```js {{ del: [1], ins: [2] }}
import { MultiSessionAppSupport } from '@clerk/clerk-react'
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guides/upgrading-from-v2-to-v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Users who have built custom auth flows using the SignIn and SignUp resources can

The new `getToken()` method accepts an optional `{ template: string; }` object, used to specify the JWT template you want to use.

Please note that If you want to fetch a token for an integration, you must prefix the integration name with `integration_`, eg: `getToken({ template: 'integration_firebase' })`.
If you want to fetch a token for an integration, you must prefix the integration name with `integration_`, eg: `getToken({ template: 'integration_firebase' })`.

Moreover, the following methods now accept a params objects instead of positional params: `createEmailAddress()`, `createPhoneNumber()`, `setProfileImage()`.

Expand Down
Loading

0 comments on commit 206821d

Please sign in to comment.