Skip to content

Commit fb7250a

Browse files
authored
chore: add AX locales docs (#2328)
chore: AX locales docs
1 parent b6356cf commit fb7250a

File tree

11 files changed

+149
-85
lines changed

11 files changed

+149
-85
lines changed

docs/account-experience/index.mdx

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,26 @@ The Account Experience can be themed using the Ory Console. Head over to the
2020
[theming settings](https://console.ory.sh/projects/current/account-experience/theming). It is also possible to set a custom logo
2121
and favicon.
2222

23-
## Welcome Screen
24-
25-
The Account Experience comes with a welcome screen that shows information about the current user's session. As this screen is
26-
rather meant for debugging purposes, it can be disabled in the [Ory Console](https://console.ory.sh/projects/current/ui).
27-
2823
## Translations (i18n) & Message Customization
2924

3025
Currently, the account experience is available in 83 languages. For a full list of available languages please have a look at
3126
[the source](https://github.com/ory/elements/tree/main/packages/elements-react/src/locales). If you want to add a new language or
32-
fix some wording, please open a pull request in [ory/elements](https://github.com/ory/elements#internalization-i18n). To determine
33-
the language to use, the Account Experience uses the `Accept-Language` header. If the language is not available, the fallback
34-
language (English) is used. Custom translations are not supported at the moment, but please reach out if you need this feature.
27+
fix some wording, please open a pull request in [ory/elements](https://github.com/ory/elements#internalization-i18n).
28+
29+
By default, the Account Experience automatically adapts to the user's language preferences, and offers translations for all
30+
supported languages. Each language can be enabled or disabled in the Ory Console
31+
under&nbsp;<ConsoleLink route="project.accountExperience.locales" />.
32+
33+
To determine the language to use, the Account Experience uses the `Accept-Language` header. If the language is not available, the
34+
Default Language (English) is used. To change the default language, go
35+
to&nbsp;<ConsoleLink route="project.accountExperience.locales" /> and select your preferred default language.
36+
37+
To turn off automatic language detection, disable **Respect the user's system language preferences** in the Ory Console
38+
under&nbsp;<ConsoleLink route="project.accountExperience.locales" />.
3539

36-
## Custom Domains
40+
### Custom locales
3741

38-
The Account Experience is also available under custom domains the same way it works on the slug URL.
42+
You can customize any of the existing translations or add your own translations in the Ory Console
43+
under&nbsp;<ConsoleLink route="project.accountExperience.locales" />. Click on the edit icon for the language you want to
44+
customize, and then modify the messages as needed. Custom translations will override the default translations provided by Ory
45+
Elements.

docs/concepts/redirects.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The Ory Network has a total of six flows, **Login**, **Registration**, **Verific
3333
which can be configured to redirect back to any URL. A common use case would be to redirect the user to your application home
3434
screen after a logout or to a specific URL on a sub-domain after a settings password update.
3535

36-
On project creation the redirect flows are by default set to the Ory Account Experience pages.
36+
By default, the flows always redirect to the Ory Account Experience pages.
3737

3838
### Login, registration, and settings
3939

docs/guides/custom-domains.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,8 @@ show "Enabled/Disabled".
253253

254254
![Custom Domain Cors enabled](./_static/custom-domains/cname-cors-enabled.png)
255255

256-
Once active, the Ory Account Experience is reachable at `https://<your-custom-domain>/ui/welcome`. Learn how to configure a custom
257-
UI: [Bring Your Own UI](../kratos/bring-your-own-ui/configure-ory-to-use-your-ui).
256+
Once active, the Ory Account Experience is reachable at `https://<your-custom-domain>/login`. Learn how to configure a custom UI:
257+
[Bring Your Own UI](../kratos/bring-your-own-ui/configure-ory-to-use-your-ui).
258258

259259
You may also remove your custom domain from the Console, but please note that **any requests to it will no longer resolve** once
260260
you do.

docs/identities/get-started/account-recovery.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,9 @@ feature_flags:
9292
When integrating with the API directly, your applications must send and receive these fields. Refer to the
9393
[API documentation](../../reference/api#tag/frontend/operation/updateRecoveryFlow) for more details.
9494

95-
When using the built-in Account Experience UI, there is nothing special to do. Otherwise, you need to do some changes.
95+
When using the built-in Ory Account Experience, no changes are needed in your application code.
96+
97+
If you're using a custom UI, ensure that your recovery forms handle the new fields appropriately:
9698

9799
New fields have been added to the payload when getting and updating the recovery flow that are exclusively used when this feature
98100
flag is enabled:

docs/identities/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ the Ory documentation. Read [more here](../kratos/manage-identities/01_overview.
3636
Identity is a hard problem that Ory Identities solves in a unique way. Ory values security, flexibility, and integration with
3737
cloud technology such as Kubernetes the most:
3838

39-
- Ory Identities doesn't ship an HTML Rendering Engine. You use the Ory Account Experience available in Ory Network or build your
40-
own UI in the language and framework you feel most comfortable with.
39+
- Ory Identities doesn't ship an HTML Rendering Engine. You can use the Ory Account Experience available in Ory Network or build
40+
your own UI in the language and framework you feel most comfortable with.
4141
- The workflow engine allows you to fully customize your users' experience. Whether you want users to activate their accounts
4242
after registration, or have a multi-step (progressive) registration process - it's all possible!
4343
- One [identity schema](../kratos/manage-identities/01_overview.mdx) doesn't fit all - you may have customers that need a billing

docs/identities/sign-in/identifier-first-authentication.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,11 @@ To enable it:
2222
- 1. Log in to the [Ory Console](https://console.ory.sh).
2323
- 2. Select your project.
2424
- 3. Navigate to <ConsoleLink route="project.accountExperience.theming.route" />.
25-
- 4. Enable "Enable Account Experience 2.0 (preview)".
26-
- 5. Navigate to <ConsoleLink route="project.ui.route" />
27-
- 6. Click "Apply new UI URLs".
28-
- 7. Test the flow in your application by navigating to the login page.
25+
- 4. Disable "Use legacy Hosted UI".
26+
- 5. Test the flow in your application by navigating to the login page.
2927

30-
To revert, follow the same steps, disable "New Account Experience", and click "Reset to Account Experience".
28+
To revert, follow the same steps, enable "Use legacy Hosted UI", and click "Reset to Account Experience" on
29+
the&nbsp;<ConsoleLink route="project.ui" />.
3130

3231
## Self-hosted Ory Kratos
3332

docs/intro.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,8 @@ Ory Console is the management UI of Ory Network.
110110
Ory Account Experience implements screens such as login, registration, account recovery, account setting, and account verification
111111
for fast adoption of Ory.
112112

113-
Contrary to other vendors, Ory allows you to implement your own (login, registration, ...) UI by offering simple, headless APIs.
114-
Use the open-source [Ory Elements](https://github.com/ory/elements) components library for fast integration with frameworks like
115-
ExpressJS, React, or Preact.
113+
Ory allows you to implement your own authentication UI by offering simple, headless APIs. Use the open-source
114+
[Ory Elements](https://github.com/ory/elements) components library for fast integration with frameworks like React and Next.js.
116115

117116
### Ory Actions
118117

docs/kratos/bring-your-own-ui/20_configure-ory-to-use-your-ui.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Configuration URL, go to <ConsoleLink route="project.settings" />, and copy the
1313

1414
:::
1515

16-
By default, self-service flows use [Ory Account Experience](./01_overview.mdx#why-should-i-use-ory-account-experience), which is a
17-
part of every Ory Network project. In the default setup, the system uses relative paths to point to the appropriate UI for every
18-
screen. The relative links that point to the Ory Account Experience follow the `/ui/{flow_name}` format.
16+
By default, self-service flows use [Ory Account Experience](./01_overview.mdx#why-should-i-use-ory-account-experience). In the
17+
default setup, the system uses relative paths to point to the appropriate UI for every screen. The relative links that point to
18+
the Ory Account Experience follow the `/ui/{flow_name}` format.
1919

2020
## Custom domain setup
2121

docs/oauth2-oidc/identity-provider-integration-settings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import TabItem from '@theme/TabItem';
3232
<Tabs>
3333
<TabItem value="console" label="Ory Console" default>
3434
35-
Go to <ConsoleLink route="project.oauthConfiguration.identityIntegration" /> and `Enable Override Return To` setting.
35+
Go to <ConsoleLink route="project.settings.advanced" /> and enable the `OAuth2 provider override "return_to` setting.
3636
3737
</TabItem>
3838

src/components/ConsoleLink/console-nav-data.ts

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export const getStartedPaths: Path[] = [
2222
href: routes.project.getStarted.route + "#integrations",
2323
},
2424
{
25-
title: "Guides and Tutorials",
25+
title: "Guides and concepts",
2626
href: routes.project.getStarted.route + "#guides-tutorials",
2727
},
2828
{ title: "Community", href: routes.project.getStarted.route + "#community" },
@@ -31,15 +31,15 @@ export const getStartedPaths: Path[] = [
3131
export const activityPaths: Path[] = [
3232
{ title: "Live", href: routes.project.activity.route },
3333
{
34-
title: "Logs & Events",
34+
title: "Logs & events",
3535
href: routes.project.activity.events.route,
3636
},
3737
{ title: "Sessions", href: routes.project.sessions.list.route },
38-
{ title: "Email delivery", href: routes.project.courierMessages.route },
38+
{ title: "Message delivery", href: routes.project.courierMessages.route },
3939
]
4040

4141
export const identititesPaths: Path[] = [
42-
{ title: "Users & Identities", href: routes.project.identities.list.route },
42+
{ title: "Users & identities", href: routes.project.identities.list.route },
4343
{ title: "Identity schema", href: routes.project.identitySchema.route },
4444
{
4545
title: "Import users",
@@ -53,6 +53,10 @@ export const brandingPaths: Path[] = [
5353
title: "Theming",
5454
href: routes.project.accountExperience.theming.route,
5555
},
56+
{
57+
title: "Localization",
58+
href: routes.project.accountExperience.locales.route,
59+
},
5660
{
5761
title: "Custom domains",
5862
href: routes.project.cname.route,
@@ -65,6 +69,10 @@ export const brandingPaths: Path[] = [
6569
title: "UI URLs",
6670
href: routes.project.ui.route,
6771
},
72+
{
73+
title: "Email templates",
74+
href: routes.project.emailTemplates.route,
75+
},
6876
]
6977

7078
export const authenticationPaths: Path[] = [
@@ -81,17 +89,23 @@ export const authenticationPaths: Path[] = [
8189
href: routes.project.mfa.route,
8290
},
8391
{
84-
title: "Social Sign-In",
92+
title: "Social Sign-In (OIDC)",
8593
href: routes.project.socialSignIn.route,
8694
},
8795
{
88-
title: "Actions & Webhooks",
89-
href: routes.project.developers.actions.route,
96+
title: "SAML Sign-In",
97+
href: routes.project.saml.route,
98+
pill: "Preview",
9099
},
91100
{
92101
title: "Enterprise SSO",
93102
href: routes.project.authentication.organizations.route,
94103
},
104+
105+
{
106+
title: "Sessions",
107+
href: routes.project.authentication.sessionSettings.route,
108+
},
95109
{
96110
title: "Account recovery",
97111
href: routes.project.recovery.route,
@@ -101,39 +115,51 @@ export const authenticationPaths: Path[] = [
101115
href: routes.project.verification.route,
102116
},
103117
{
104-
title: "Email configuration",
118+
title: "Email Configuration",
105119
href: routes.project.emailConfiguration.route,
106120
},
107121
{
108-
title: "Email templates",
109-
href: routes.project.emailTemplates.route,
110-
},
111-
{
112-
title: "SMS configuration",
122+
title: "SMS Configuration",
113123
href: routes.project.smsConfiguration.route,
114124
},
115125
{
116-
title: "Sessions",
117-
href: routes.project.authentication.sessionSettings.route,
126+
title: "Actions & Webhooks",
127+
href: routes.project.developers.actions.route,
118128
},
119129
]
120130

121131
export const oauthPaths: Path[] = [
122132
{
123-
title: "Overview",
124-
href: routes.project.oauthConfiguration.overview.route,
133+
title: "Clients and applications",
134+
href: routes.project.oauthConfiguration.route,
125135
},
126136
{
127-
title: "OAuth2 Clients",
128-
href: routes.project.oauthConfiguration.route,
137+
title: "Endpoints",
138+
href: routes.project.oauthConfiguration.endpoints.route,
129139
},
130140
{
131-
title: "Configuration",
141+
title: "General",
132142
href: routes.project.oauthConfiguration.configure.route,
133143
},
134144
{
135-
title: "Identity integration settings",
136-
href: routes.project.oauthConfiguration.identityIntegration.route,
145+
title: "OpenID Connect",
146+
href: routes.project.oauthConfiguration.openid.route,
147+
},
148+
{
149+
title: "URLs",
150+
href: routes.project.oauthConfiguration.urls.route,
151+
},
152+
{
153+
title: "Lifespans",
154+
href: routes.project.oauthConfiguration.lifespans.route,
155+
},
156+
{
157+
title: "Token strategies",
158+
href: routes.project.oauthConfiguration.strategies.route,
159+
},
160+
{
161+
title: "Cookies",
162+
href: routes.project.oauthConfiguration.cookies.route,
137163
},
138164
]
139165

@@ -217,7 +243,7 @@ export const projectPaths: RootPath[] = [
217243
},
218244
{
219245
title: "OAuth 2",
220-
href: routes.project.oauthConfiguration.overview.route,
246+
href: routes.project.oauthConfiguration.route,
221247
paths: oauthPaths,
222248
},
223249
{

0 commit comments

Comments
 (0)