Skip to content

Commit 6892f73

Browse files
iPagarPavel Garaev
andauthored
docs: fixed typos (#409)
* docs: update manage-users * docs: update interact-with-management-api Signed-off-by: Pavel Garaev <p.garaev@beetbarrel.ru> * docs: update management-api Signed-off-by: Pavel Garaev <p.garaev@beetbarrel.ru> * docs: update you-dont-need-a-user-table Signed-off-by: Pavel Garaev <p.garaev@beetbarrel.ru> * docs: update configure-social-connector Signed-off-by: Pavel Garaev <p.garaev@beetbarrel.ru> --------- Signed-off-by: Pavel Garaev <p.garaev@beetbarrel.ru> Co-authored-by: Pavel Garaev <p.garaev@beetbarrel.ru>
1 parent 679c414 commit 6892f73

File tree

10 files changed

+16
-12
lines changed

10 files changed

+16
-12
lines changed

docs/docs/recipes/configure-connectors/configure-social-connector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Logto offers two types of social connectors:
1313
- **Standard Connectors**: OIDC, OAuth 2.0, SAML.
1414

1515
:::tip
16-
If the social connector you need isn't among our Common Social Connectors, you can create your own using the Standard Connector protocol. Check out our “[Custom Social Connector with Standard Protocol](../custom social connector with standard protocol.md)” guide to learn more.
16+
If the social connector you need isn't among our Common Social Connectors, you can create your own using the Standard Connector protocol. Check out our “[Custom Social Connector with Standard Protocol](./custom-social-connector-with-standard-protocols.md)” guide to learn more.
1717
If the Standard Connector still doesn't meet your needs, don't hesitate to contact us. For those using the Logto Open-Source Version, you can even [Write your connector (OSS)](../create-your-connector/).
1818
:::
1919

docs/docs/recipes/interact-with-management-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ While Logto's sign-in experience is exceptional, there may be instances where yo
3939

4040
### Advanced user search
4141

42-
You can certainly use Logto's user management feature in the console for some tasks, our management API offers additional functions that support more advanced user search scenarios.Check out [Advanced User Search](../manage-users/advanced-user-search/) for more information.
42+
You can certainly use Logto's user management feature in the console for some tasks, our management API offers additional functions that support more advanced user search scenarios. Check out [Advanced User Search](../manage-users/advanced-user-search/) for more information.
4343

4444
Our developers have implemented many additional features using our management API. We believe that our API is highly scalable and can support a wide range of your needs. Additionally, we have continued distilling some use cases and incorporated them into our low-code platform to boost productivity and enhance the developer experience.
4545

docs/docs/recipes/manage-users/admin-console.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,12 @@ To view the details of a user, simply click on the corresponding row in the user
4040
Please note that while the full name, avatar image URL, and custom data can be edited, the social connections can be removed, and the other properties are read-only.
4141

4242
:::danger
43-
It is important to confirm that the user has an alternative sign-in method before removing a social connection, such as another social connection, phone number, email, or username-with-password. If the user does not have any other sign-in method, they will not be able to access their account again once the social connection is removed.:::
43+
It is important to confirm that the user has an alternative sign-in method before removing a social connection, such as another social connection, phone number, email, or username-with-password. If the user does not have any other sign-in method, they will not be able to access their account again once the social connection is removed.
44+
:::
4445

4546
:::info
46-
Don't forget to click "Save changes" after updating.:::
47+
Don't forget to click "Save changes" after updating.
48+
:::
4749

4850
![User profile](./assets/user-profile.png)
4951

docs/docs/recipes/manage-users/management-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 2
55

66
# Manage users using Management API
77

8-
[Management API](../../../docs/references/core/README.mdx#management-api)is a collection of APIs that provide access to the Logto backend service. As previously mentioned, the user API is a critical component of this service and can support a wide range of scenarios.
8+
[Management API](../../../docs/references/core/README.mdx#management-api) is a collection of APIs that provide access to the Logto backend service. As previously mentioned, the user API is a critical component of this service and can support a wide range of scenarios.
99
:::info
1010
[**Authentication**](../../../docs/references/core/README.mdx#authentication) is REQUIRED when you're calling Management API.
1111
:::

docs/docs/recipes/manage-users/you-dont-need-a-user-table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We suggest utilizing the `user.id` property to identify a user, as we ensure eac
1212

1313
When using Logto as an identity solution, it is important to consider how to organize user information and related data. This involves defining a user schema to determine the structure and properties of a user object and deciding how to store and manage user-related data.
1414

15-
In the past, it was common for developers to create a user table in a SQL database to store a user's profile and related information. They would then establish a many-to-one relationship in other tables using a `user`column that pointed back to the user table. Other identity providers, such as Google, would require the creation of a `google_id`column to enable "sign in with Google" functionality. However, this approach is not appropriate for Logto since it is not just a service provider, but also an identity provider. Logto is a comprehensive solution that can manage all user-related information, including identifiers, social connections, custom data, and more. Therefore, creating a `logto_id`column is not an effective strategy.
15+
In the past, it was common for developers to create a user table in a SQL database to store a user's profile and related information. They would then establish a many-to-one relationship in other tables using a `user` column that pointed back to the user table. Other identity providers, such as Google, would require the creation of a `google_id` column to enable "sign in with Google" functionality. However, this approach is not appropriate for Logto since it is not just a service provider, but also an identity provider. Logto is a comprehensive solution that can manage all user-related information, including identifiers, social connections, custom data, and more. Therefore, creating a `logto_id` column is not an effective strategy.
1616

1717
Using Logto eliminates the need for a user table.
1818

versioned_docs/version-1.x/docs/recipes/configure-connectors/configure-social-connector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Logto offers two types of social connectors:
1313
- **Standard Connectors**: OIDC, OAuth 2.0, SAML.
1414

1515
:::tip
16-
If the social connector you need isn't among our Common Social Connectors, you can create your own using the Standard Connector protocol. Check out our “[Custom Social Connector with Standard Protocol](../custom social connector with standard protocol.md)” guide to learn more.
16+
If the social connector you need isn't among our Common Social Connectors, you can create your own using the Standard Connector protocol. Check out our “[Custom Social Connector with Standard Protocol](./custom-social-connector-with-standard-protocols.md)” guide to learn more.
1717
If the Standard Connector still doesn't meet your needs, don't hesitate to contact us. For those using the Logto Open-Source Version, you can even [Write your connector (OSS)](../create-your-connector/).
1818
:::
1919

versioned_docs/version-1.x/docs/recipes/interact-with-management-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ While Logto's sign-in experience is exceptional, there may be instances where yo
3939

4040
### Advanced user search
4141

42-
You can certainly use Logto's user management feature in the console for some tasks, our management API offers additional functions that support more advanced user search scenarios.Check out [Advanced User Search](../manage-users/advanced-user-search/) for more information.
42+
You can certainly use Logto's user management feature in the console for some tasks, our management API offers additional functions that support more advanced user search scenarios. Check out [Advanced User Search](../manage-users/advanced-user-search/) for more information.
4343

4444
Our developers have implemented many additional features using our management API. We believe that our API is highly scalable and can support a wide range of your needs. Additionally, we have continued distilling some use cases and incorporated them into our low-code platform to boost productivity and enhance the developer experience.
4545

versioned_docs/version-1.x/docs/recipes/manage-users/admin-console.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,12 @@ To view the details of a user, simply click on the corresponding row in the user
4040
Please note that while the full name, avatar image URL, and custom data can be edited, the social connections can be removed, and the other properties are read-only.
4141

4242
:::danger
43-
It is important to confirm that the user has an alternative sign-in method before removing a social connection, such as another social connection, phone number, email, or username-with-password. If the user does not have any other sign-in method, they will not be able to access their account again once the social connection is removed.:::
43+
It is important to confirm that the user has an alternative sign-in method before removing a social connection, such as another social connection, phone number, email, or username-with-password. If the user does not have any other sign-in method, they will not be able to access their account again once the social connection is removed.
44+
:::
4445

4546
:::info
46-
Don't forget to click "Save changes" after updating.:::
47+
Don't forget to click "Save changes" after updating.
48+
:::
4749

4850
![User profile](./assets/user-profile.png)
4951

versioned_docs/version-1.x/docs/recipes/manage-users/management-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 2
55

66
# Manage users using Management API
77

8-
[Management API](../../../docs/references/core/README.mdx#management-api)is a collection of APIs that provide access to the Logto backend service. As previously mentioned, the user API is a critical component of this service and can support a wide range of scenarios.
8+
[Management API](../../../docs/references/core/README.mdx#management-api) is a collection of APIs that provide access to the Logto backend service. As previously mentioned, the user API is a critical component of this service and can support a wide range of scenarios.
99
:::info
1010
[**Authentication**](../../../docs/references/core/README.mdx#authentication) is REQUIRED when you're calling Management API.
1111
:::

versioned_docs/version-1.x/docs/recipes/manage-users/you-dont-need-a-user-table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We suggest utilizing the `user.id` property to identify a user, as we ensure eac
1212

1313
When using Logto as an identity solution, it is important to consider how to organize user information and related data. This involves defining a user schema to determine the structure and properties of a user object and deciding how to store and manage user-related data.
1414

15-
In the past, it was common for developers to create a user table in a SQL database to store a user's profile and related information. They would then establish a many-to-one relationship in other tables using a `user`column that pointed back to the user table. Other identity providers, such as Google, would require the creation of a `google_id`column to enable "sign in with Google" functionality. However, this approach is not appropriate for Logto since it is not just a service provider, but also an identity provider. Logto is a comprehensive solution that can manage all user-related information, including identifiers, social connections, custom data, and more. Therefore, creating a `logto_id`column is not an effective strategy.
15+
In the past, it was common for developers to create a user table in a SQL database to store a user's profile and related information. They would then establish a many-to-one relationship in other tables using a `user` column that pointed back to the user table. Other identity providers, such as Google, would require the creation of a `google_id` column to enable "sign in with Google" functionality. However, this approach is not appropriate for Logto since it is not just a service provider, but also an identity provider. Logto is a comprehensive solution that can manage all user-related information, including identifiers, social connections, custom data, and more. Therefore, creating a `logto_id` column is not an effective strategy.
1616

1717
Using Logto eliminates the need for a user table.
1818

0 commit comments

Comments
 (0)