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

chore: change wording and move periods outside of links #1703

Merged
merged 26 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
0f845e1
for more details -> for more information
victoriaxyz Nov 13, 2024
bb40128
check out -> see
victoriaxyz Nov 13, 2024
782ecce
remove our
victoriaxyz Nov 13, 2024
f3de5bb
move period out of link
victoriaxyz Nov 13, 2024
93b254c
move "the" out of link
victoriaxyz Nov 13, 2024
3bcb892
remove please and replace "reach out" with "contact"
victoriaxyz Nov 13, 2024
d5a9e65
lint
victoriaxyz Nov 13, 2024
2427fd4
merge conflicts
victoriaxyz Nov 14, 2024
edae0c9
Merge branch 'main' into vi/chore/edits
alexisintech Nov 14, 2024
be5d6fc
Update docs/advanced-usage/using-proxies.mdx
victoriaxyz Nov 14, 2024
be6082a
Update styleguides/STYLEGUIDE.md
victoriaxyz Nov 14, 2024
347d9cb
Update CONTRIBUTING.md
victoriaxyz Nov 14, 2024
04ec13f
Apply suggestions from code review
victoriaxyz Nov 14, 2024
91ad229
Update styleguides/STYLEGUIDE.md
victoriaxyz Nov 14, 2024
bd79510
Merge branch 'main' into vi/chore/edits
victoriaxyz Nov 14, 2024
3ed549c
Set up your application guide -> setup guide
victoriaxyz Nov 14, 2024
54fb35b
fix
victoriaxyz Nov 15, 2024
c1f9545
Merge branch 'main' into vi/chore/edits
victoriaxyz Nov 15, 2024
d216df3
Merge branch 'main' into vi/chore/edits
victoriaxyz Nov 18, 2024
48b7df2
Merge branch 'main' into vi/chore/edits
victoriaxyz Nov 18, 2024
427f075
set up your application guide --> setup guide
alexisintech Nov 18, 2024
2d88707
Update docs/integrations/databases/firebase.mdx
alexisintech Nov 18, 2024
26907a0
Update docs/integrations/webhooks/overview.mdx
alexisintech Nov 18, 2024
57b45db
Update docs/quickstarts/ios.mdx
alexisintech Nov 18, 2024
6099506
Update docs/references/sdk/fullstack.mdx
alexisintech Nov 18, 2024
206821d
remove please
alexisintech Nov 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Clerk's documentation

Thanks for being willing to contribute to [Clerk's documentation](https://clerk.com/docs)! This document outlines how to effectively contribute to the documentation content located in this repository. Check out the [style guide](./styleguides/styleguide.md) for more information on our guidelines for writing content.
Thanks for being willing to contribute to [Clerk's documentation](https://clerk.com/docs)! This document outlines how to effectively contribute to the documentation content located in this repository. See the [style guide](./styleguides/styleguide.md) for more information on our guidelines for writing content.

## Written in MDX

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage/clerk-idp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Clerk can be configured as an identity provider to facilitate Single Sign-On (SS

## 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 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 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).**

## How it works

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage/satellite-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -407,4 +407,4 @@ To access authentication state from a satellite domain, users will be transparen
You can repeat this process and create as many satellite applications as you need.
</Steps>

If you have any questions about satellite domains, or you're having any trouble setting this up, please contact [[email protected]](mailto:[email protected])
If you have any questions about satellite domains, or you're having any trouble setting this up, contact [[email protected]](mailto:[email protected])
6 changes: 3 additions & 3 deletions docs/advanced-usage/using-proxies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When using a proxy, all requests to the Frontend API will be made through your d
To get started, you need to create an application from the [Clerk Dashboard](https://dashboard.clerk.com/). Once you create an instance via the Clerk Dashboard, you will be prompted to choose a domain. For the purposes of this guide, the domain will be `app.dev`.

> [!NOTE]
> For more information on creating a Clerk application, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
> For more information on creating a Clerk application, see the [setup guide](/docs/quickstarts/setup-clerk).
### Configure your proxy server

Expand Down Expand Up @@ -146,7 +146,7 @@ When using a proxy, all requests to the Frontend API will be made through your d
</Tabs>

> [!NOTE]
> Every proxy configuration will be different and we're here to help. Please [reach out](/contact/support){{ target: '_blank' }} if there's a specific use-case you're looking to solve.
> Every proxy configuration will be different and we're here to help. [Contact support](/contact/support){{ target: '_blank' }} if there's a specific use-case you're looking to solve.
### Enable proxying

Expand Down Expand Up @@ -305,4 +305,4 @@ When using a proxy, all requests to the Frontend API will be made through your d
Your application should now be able to access the Frontend API from your proxy!
</Steps>

If you have any questions about proxying, or you're having any trouble setting this up, please contact [[email protected]](mailto:[email protected]).
If you have any questions about proxying, or you're having any trouble setting this up, contact [[email protected]](mailto:[email protected]).
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ It will be useful to take a look at the following terms as they will reappear in

### Revolvapp WYSIWYG email editor plugin

The email editor uses the [Revolvapp](https://imperavi.com/redactor/legacy/revolvapp) email template editor plugin by Imperavi. To acquaint yourself with the template markup syntax, please consult the corresponding [documentation page](https://imperavi.com/redactor/legacy/revolvapp/docs/syntax/quick-start).
The email editor uses the [Revolvapp](https://imperavi.com/redactor/legacy/revolvapp) email template editor plugin by Imperavi. To acquaint yourself with the template markup syntax, consult [Imperavi's docs](https://imperavi.com/redactor/legacy/revolvapp/docs/syntax/quick-start).

As you will see, the template markup is an HTML-like language and each type of node supports its own set of attributes which control its behavior. A lot of the attributes are borrowed from HTML itself.

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/configuration/session-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ There are two main ways to add the multi-session feature to your application:

Session tokens are JWTs that contain a set of [default claims](/docs/backend-requests/resources/session-tokens) required by Clerk. You can customize these tokens by providing additional claims of your own.

To learn how to customize session tokens, check out our [Customize your session token](/docs/backend-requests/making/custom-session-token) guide.
To learn how to customize session tokens, see the [dedicated guide](/docs/backend-requests/making/custom-session-token).
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,4 @@ To reset a user's MFA:

## Restrictions

Clerk provides a set of restriction options designed to provide you with enhanced control over who can gain access to your application. Restrictions can limit sign-ups or prevent accounts with specific identifiers, such as email addresses, phone numbers, and even entire domains, from accessing your application. [Learn more about restrictions.](/docs/authentication/configuration/restrictions)
Clerk provides a set of restriction options designed to provide you with enhanced control over who can gain access to your application. Restrictions can limit sign-ups or prevent accounts with specific identifiers, such as email addresses, phone numbers, and even entire domains, from accessing your application. [Learn more about restrictions](/docs/authentication/configuration/restrictions).
2 changes: 1 addition & 1 deletion docs/authentication/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Clerk supports multiple authentication strategies so that you can implement the

Clerk's configuration settings affect how the users of your application can [sign up and sign in](/docs/authentication/configuration/sign-up-sign-in-options) and which properties are editable via their user profile. You can also manage [user sessions](/docs/authentication/configuration/session-options), [control who gets access](/docs/authentication/configuration/restrictions) to your application, and [customize the email & SMS messages](/docs/authentication/configuration/email-sms-templates) that are sent by Clerk during authentication flows. All of these settings can be found under the **User & Authentication** section in the [Clerk Dashboard](https://dashboard.clerk.com/).

Check out our detailed guide for information on [how to set up your application](/docs/quickstarts/setup-clerk).
For more information on how to set up your application, see the [setup guide](/docs/quickstarts/setup-clerk).
2 changes: 1 addition & 1 deletion docs/authentication/saml/custom-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Clerk supports Enterprise SSO via the SAML protocol, enabling you to create auth

For example, say you were using Google as your IdP. Google users have the "Phone number" attribute. Clerk does not have a direct mapping for this attribute, as you can see in the Clerk Dashboard in the **Attribute mapping** section. Instead, in the Google dashboard, you would map Google's "Phone number" claim to `public_metadata_phone_number`. Then, in Clerk, the value for the user's phone number would be saved in the user's `User.publicMetadata` under the key `phone_number`.

[Learn more about how to access the metadata from our APIs.](/docs/users/metadata)
Learn more about [how to access the metadata from our APIs](/docs/users/metadata).

### Activate your SAML connection

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/saml/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ description: Learn how to integrate Google Workspace with Clerk using SAML SSO.

The value for the user's phone number will be saved in the user's `User.publicMetadata` under the key `phone_number`.

[Learn more about how to access the metadata from our APIs.](/docs/users/metadata)
Learn more about [how to access the metadata from our APIs](/docs/users/metadata).

### Enable the connection on Google

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/saml/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ For development instances, SAML connections will always be free, but capped to 5

### Can I get a bulk discount?

Yes, [reach out to support](/contact/support){{ target: '_blank' }} to work out a custom plan.
Yes, [contact support](/contact/support){{ target: '_blank' }} to work out a custom plan.
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/atlassian.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to generate your own Client ID and Clien
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Atlassian developer account. To create one, [click here](https://developer.atlassian.com/).

## Configuring an Atlassian OAuth 2.0 Integration
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/bitbucket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to generate your own Consumer Key and Co
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Bitbucket account. To create one, [click here](https://bitbucket.org/account/signup).

## Configuring Bitbucket social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to generate your own Client ID and Clien
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Box developer account. To create one, [click here](https://developer.box.com/).

## Configuring Box social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/dropbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to generate your own Client ID and Clien
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Dropbox account. To create one, [click here](https://www.dropbox.com/lp/developers).

## Configuring Dropbox social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/facebook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to create your own developer account wit
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Facebook Developer account. To create one, consult the [Register as a Facebook developer](https://developers.facebook.com/docs/development/register) page.

## Configuring Facebook social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/hubspot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to create your own developer account wit
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a HubSpot Developer account. To create one, [click here](https://app.hubspot.com/signup/developers/step/existing-user?_ga=2.145169076.1430980384.1628431607-741498900.1628431607).

## Configuring HubSpot social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/line.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For production instances, you will need to generate your own Client ID and Clien
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a LINE developer account. To create one, [click here](https://developers.line.biz/en/).

## Configuring LINE social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/linkedin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For production instances, you will need to generate your own Client ID and Clien
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a LinkedIn account. To create one, [click here](https://developer.linkedin.com/).

## Configuring LinkedIn social connection
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/notion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to generate your own Client ID and Clien
## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Notion developer account. To create one, [click here](https://developers.notion.com/).

## Configuring Notion social connection
Expand Down
10 changes: 5 additions & 5 deletions docs/authentication/social-connections/oauth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Clerk makes it easy to add social connection capabilities to your application. W
> [!NOTE]
> When using social connections, the sign-up and sign-in flows are equivalent. If a user doesn't have an account and tries to sign in, an account will be made for them, and vice versa.

The easiest way to add social connections to your Clerk app is by using [prebuilt components](/docs/components/overview). If you prefer a more custom solution, check out how to [build a social connection flow using the Clerk API](/docs/custom-flows/oauth-connections).
The easiest way to add social connections to your Clerk app is by using [prebuilt components](/docs/components/overview). If you prefer a more custom solution, see the [build a social connection flow using the Clerk API guide](/docs/custom-flows/oauth-connections).

## Before you start

- You need to create a Clerk application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out the [Set up your application](/docs/quickstarts/setup-clerk) guide.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved
- You need to install the correct SDK for your application. You can find steps on how to do so through the [quickstart guides.](/docs/quickstarts/overview)
- You need to install the correct SDK for your application. For more information, see the [quickstart guides](/docs/quickstarts/overview).

## Enable a social connection

Expand Down Expand Up @@ -142,13 +142,13 @@ To configure the option for users to sign up and sign in with a social provider:

When signed in, a user can connect to further social providers. There is no need to perform another sign-up.

When using the [Account Portal](/docs/customization/account-portal/overview) pages, users can see which providers they have already connected to and which ones they can still connect to on their [user profile page.](/docs/customization/account-portal/overview#user-profile)
When using the [Account Portal](/docs/customization/account-portal/overview) pages, users can see which providers they have already connected to and which ones they can still connect to on their [user profile page](/docs/customization/account-portal/overview#user-profile).

When using the [prebuilt components](/docs/components/overview), you can use the [`<UserProfile/>`](/docs/components/user/user-profile) component to allow users to connect to further social providers.

## OAuth for native applications

Currently, the prebuilt components are not supported in native applications, but you can use the Clerk API to [build a custom flow for authenticating with social connections.](/docs/custom-flows/oauth-connections)
Currently, the prebuilt components are not supported in native applications, but you can use the Clerk API to [build a custom flow for authenticating with social connections](/docs/custom-flows/oauth-connections).

Clerk ensures that security critical nonces are passed only to allowlisted URLs when the OAuth flow is completed in native browsers or webviews. For maximum security in your **production** instances, you need to allowlist your custom redirect URLs via the [Clerk Dashboard](https://dashboard.clerk.com/) or the [Clerk Backend API](/docs/references/backend/redirect-urls/create-redirect-url).

Expand All @@ -164,4 +164,4 @@ You can use [Sign in with Apple](https://developer.apple.com/sign-in-with-apple/

Instead of the typical OAuth flow that performs redirects in a browser context, you can utilize Apple's native authorization and provide the openID token and grant code to Clerk. Clerk ensures that the user will be verified in a secure and reliable way with the information that Apple has provided about the user.

See [the dedicated guide](/docs/authentication/social-connections/apple) for additional information on how to configure Apple as a social provider for your Clerk instance.
For additional information on how to configure Apple as a social provider for your Clerk instance, see the [dedicated guide](/docs/authentication/social-connections/apple).
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,4 @@ Clerk provides a wide range of social providers to ease your user's sign-up and
- ![](/docs/images/logos/auth_providers/huggingface.svg)
</Cards>

Don't see the provider you're looking for? You can [configure a custom OIDC-compatible provider](/docs/authentication/social-connections/custom-provider) or [request a new one.](https://feedback.clerk.com/roadmap/f9045ac8-0c8e-4f30-b84f-8d551b0767b9?_gl=1*1ywoqdy*_gcl_au*OTUwODgxMjg2LjE3MTI1OTEwNzMuMTczNjk0NTcxMC4xNzE1MTk4MTEyLjE3MTUxOTgxMTI.)
Don't see the provider you're looking for? You can [configure a custom OIDC-compatible provider](/docs/authentication/social-connections/custom-provider) or [request a new one](https://feedback.clerk.com/roadmap/f9045ac8-0c8e-4f30-b84f-8d551b0767b9?_gl=1*1ywoqdy*_gcl_au*OTUwODgxMjg2LjE3MTI1OTEwNzMuMTczNjk0NTcxMC4xNzE1MTk4MTEyLjE3MTUxOTgxMTI.).
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/twitch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For production instances, you will need to generate your own Client ID and Clien

## Before you start

- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, check out our [Set up your application guide](/docs/quickstarts/setup-clerk).
- You need to create a Clerk Application in your [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Twitch account. To create one, [click here](https://www.twitch.tv/).

## Configuring Twitch social connection
Expand Down
Loading
Loading