Skip to content

Commit 1f8f7d2

Browse files
vinckrjonas-jonas
vinckr
and
jonas-jonas
authored
fix: new sidebarv2 (#1823)
* chore: update docusaurus to 3.X * chore: move the message descriptions to their own file * chore: format * fix: compilation issues * chore: formatting * chore: upgrade versions in workflows * chore: downgrade mermaid to 9.3 * chore: format * chore: add sharp?? * chore: format * chore: u * fix: visual regressions * chore: format * chore: cleanup * feat(wip): rework sidebar * fix: new sidebar * fix: new sidebar * fix: links * fix: new sidebar * fix: new sidebar * fix: new sidebar add oauth2 * fix: add keto and reorder a bit * fix: new sidebar * chore: update docusaurus to 3.X * chore: move the message descriptions to their own file * chore: format * fix: compilation issues * chore: formatting * chore: downgrade mermaid to 9.3 * chore: format * fix: visual regressions * feat(wip): rework sidebar * chore: format * chore: format * fix: build * fix: sidebar * chore: fix build * chore: fix build * chore: fix build * chore: fix build * chore: adjust the new sidebar (#1788) * chore: remove licenses for now * fix: ory identities overview * chore: remove unneeded overviews * fix: migration tutorial * fix: add self-hosting and top bar items * fix: merge identities intro with kratos intro * fix: simply Ory CLI reference sidebar * fix: simply Ory CLI reference sidebar * fix: simply Ory CLI reference sidebar * fix: simply Ory CLI reference sidebar * fix: broken link * chore: fix broken links * chore: add missing docs to sidebar * u * u * chore: fix broken link * chore: fix merge conflicts * chore: format * fix: sdk quickstarts * chore: move oauth2 guides --------- Co-authored-by: Jonas Hungershausen <[email protected]>
1 parent 1640aca commit 1f8f7d2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1352
-483
lines changed

‎arrow-left.svg

+3
Loading

‎docs/account-experience/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: index
3-
title: Account-Experience Overview
4-
sidebar_label: Account-Experience
3+
title: Account Experience Overview
4+
sidebar_label: Account Experience
55
---
66

77
The Ory Account Experience is the default user interface for all self-service screens like login, registration, or consent. It can

‎docs/api/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: index
33
title: gRPC + REST API Overview
4-
sidebar_label: Overview
4+
sidebar_label: API overview
55
---
66

77
```mdx-code-block
@@ -21,4 +21,4 @@ Ory Permissions supports gRPC APIs.
2121
## CORS
2222

2323
All Ory public APIs support CORS. For details on how to configure CORS for Ory Network, please refer to the
24-
[CORS documentation](../guides/cors.mdx). For self-hosted, the CORS configuration is part of the configuration file.
24+
[CORS documentation](../guides/cors.mdx). For self-hosted Ory, the CORS configuration is part of the configuration file.

‎docs/getting-started/overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: overview
3-
title: Overview
3+
title: Quickstarts & Tutorials
44
---
55

66
Are you looking for an example to just get started? Check out all available examples!

‎docs/guides/cli/01_installation.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: installation
33
title: Installation
44
---
55

6-
Ory CLI is a convenient and easy-to-use tool that helps you manage and configure Ory Network projects.
6+
The Ory CLI is a convenient and easy-to-use tool that helps you manage and configure Ory Network projects.
77

88
Its functionality is essential for self-hosting Ory components and local development. The built-in proxy and tunneling mechanisms
99
help route application traffic to the appropriate endpoints in a safe and hassle-free manner.
@@ -13,11 +13,11 @@ Network to self-hosted setups alike.
1313

1414
## Installation
1515

16-
You can install Ory CLI directly on your machine, or run the tool in Docker.
16+
You can install the Ory CLI directly on your machine, or run the tool in Docker.
1717

1818
### macOS
1919

20-
Run this command to install the CLI using Homebrew:
20+
Run this command to install the Ory CLI using Homebrew:
2121

2222
```shell
2323
brew install ory/tap/cli
@@ -31,7 +31,7 @@ ory help
3131

3232
### Linux
3333

34-
Ory CLI works on all Linux distributions. Run this command to install:
34+
The Ory CLI works on all Linux distributions. Run this command to install:
3535

3636
```shell
3737
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -b . ory

‎docs/guides/cli/15_config-identity-service.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
id: identity-cli
3-
title: Configure Ory Identities
2+
id: config-identity-service
3+
title: Ory Identities CLI
44
---
55

66
Using the Ory CLI, you can quickly adjust the configuration of the Ory Identities and apply config from the Ory Network

‎docs/guides/integrate-with-ory-cloud-through-webhooks.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: integrate-with-ory-cloud-through-webhooks
33
title: Trigger custom logic and integrate with external systems with webhooks
4-
sidebar_label: Webhooks
4+
sidebar_label: Ory Actions
55
---
66

77
Ory Actions supports webhooks, which are HTTP callbacks that can be triggered by specific events in your Ory-powered application.

‎docs/guides/ip-allowlist.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: allowlist
2+
id: ip-allowlist
33
title: Configure Ory Network IP addresses as allow list
44
sidebar_label: Ory Network IP Addresses
55
---

‎docs/guides/rate-limits.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Each of these policies incorporates two types of rate limits:
3636
| | `/relation-tuples/check` | 80 | 1800 |
3737
| | `GET /admin/identities` | 10 | 300 |
3838
| | `*` | 40 | 900 |
39-
| **Staging** | `/sessions/whoami` | 10 | 300 |
39+
| **Staging** | `/sessions/whoami` | 10 | 30 |
4040
| | `/admin/oauth2/introspect` | 10 | 300 |
4141
| | `/relation-tuples/check` | 10 | 300 |
4242
| | `GET /admin/identities` | 1 | 10 |

‎docs/hydra/sdk/05_go.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
id: go
3-
title: Go
3+
title: Ory OAuth2 Go
44
---
55

66
```mdx-code-block
77
import CodeBlock from "@theme/CodeBlock"
88
import { useLatestTag } from '@site/src/hooks'
99
```
1010

11-
In this document you can find code examples for a self-hosted Ory Kratos Go SDK.
11+
In this document you can find code examples for the Ory OAuth2 Go SDK.
1212

1313
:::info
1414

@@ -17,11 +17,11 @@ Missing an example? Please create a
1717
here.
1818

1919
You can find more examples of SDK usage in the auto-generated documentation
20-
[`kratos-client`](https://github.com/ory/kratos-client-go/tree/master/docs).
20+
[`hydra-client`](https://github.com/ory/hydra-client-go/tree/master/docs).
2121

2222
:::
2323

24-
The Ory Hydra Go SDK is generated using [`go-swagger`](http://goswagger.io).
24+
The Ory OAuth2 Go SDK is generated using [`go-swagger`](http://goswagger.io).
2525

2626
:::danger
2727

@@ -41,7 +41,7 @@ To install the Go SDK, run:
4141

4242
## Making requests
4343

44-
The following code examples show how to make requests to the Ory Hydra API.
44+
The following code examples show how to make requests to the Ory OAuth2 API.
4545

4646
### CreateOAuth2Client and ListOAuth2Clients
4747

@@ -106,4 +106,4 @@ func main() {
106106
You can find more examples of SDK usage in the autogenerated documentation:
107107

108108
- [OAuth2Api API](https://github.com/ory/hydra-client-go/blob/master/docs/OAuth2Api.md)
109-
- [OidcApi API](https://github.com/ory/hydra-client-go/blob/master/docs/OidcApi.md)
109+
- [OIDCApi API](https://github.com/ory/hydra-client-go/blob/master/docs/OidcApi.md)

‎docs/hydra/sdk/10_js.mdx

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
---
22
id: js
3-
title: JavaScript
3+
title: Ory OAuth2 JavaScript
44
---
55

6-
In this document you can find code examples for a self-hosted Ory Hydra JavaScript SDK.
6+
In this document you can find code examples for the Ory OAuth2 JavaScript SDK.
77

88
:::info
99

1010
Missing an example? Please create a
1111
[feature request](https://github.com/ory/docs/issues/new?assignees=&labels=feat&template=FEATURE-REQUEST.yml) and it will be added
1212
here.
1313

14-
You can find more examples of SDK usage in the auto-generated documentation
15-
[`kratos-client`](https://github.com/ory/kratos-client-go/tree/master/docs).
16-
1714
:::
1815

1916
:::danger
@@ -39,15 +36,15 @@ npm install --save @ory/client
3936
```js
4037
import { Configuration, PublicApi, AdminApi } from "@ory/client"
4138

42-
const hydraPublic = new PublicApi(
39+
const oryPublic = new PublicApi(
4340
new Configuration({
44-
basePath: "https://public.hydra:4444/",
41+
basePath: "https://$PROJECT_SLUG.projects.oryapis.com/",
4542
}),
4643
)
4744

48-
const hydraAdmin = new AdminApi(
45+
const oryAdmin = new AdminApi(
4946
new Configuration({
50-
basePath: "https://public.hydra:4445/",
47+
basePath: "https://$PROJECT_SLUG.projects.oryapis.com/",
5148
}),
5249
)
5350
```

‎docs/hydra/self-hosted/05_go.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: go
3-
title: Go
3+
title: Ory Hydra Go
44
---
55

66
In this document you can find code examples for the Ory Hydra Go SDK.

‎docs/identities/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: index
33
title: Introduction to Ory Identities
4-
sidebar_label: Introduction
4+
sidebar_label: Ory Identities
55
---
66

77
Ory Identities is an API-first identity and user management system built on top of the widely deployed open-source

‎docs/keto/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: index
33
title: Introduction to Ory Permissions
4-
sidebar_label: Introduction
4+
sidebar_label: Ory Permissions
55
---
66

77
# Introduction

‎docs/keto/sdk/05_go.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: go
3-
title: Go
3+
title: Ory Permissions Go
44
---
55

66
```mdx-code-block

‎docs/keto/sdk/10_python.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: python
3-
title: Python
3+
title: Ory Permissions Python
44
---
55

66
```mdx-code-block
@@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem"
99
import CodeBlock from "@theme/CodeBlock"
1010
```
1111

12-
In this document you can find code examples for the Ory Python SDK.
12+
In this document you can find code examples for the Ory Permissions Python SDK.
1313

1414
:::info
1515

‎docs/kratos/bring-your-own-ui/01_overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: custom-ui-overview
2+
id: index
33
title: Custom UI overview
44
sidebar_label: Overview
55
---

‎docs/kratos/concepts/credentials.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: credentials
3-
title: Overview
3+
title: Credentials
44
---
55

66
Each identity has one or more credentials associated with it:

‎docs/kratos/concepts/credentials/username-email-password.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: username-email-password
33
title: Login and registration using passwords
4-
sidebar_label: Overview
4+
sidebar_label: Password
55
---
66

77
The combination of identifier (username, email, phone number) and password is the oldest and most common way to authenticate users

‎docs/kratos/hooks/01_configure-hooks.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
id: configure-hooks
33
title: Ory Actions
4-
sidebar_label: Overview
54
---
65

76
# Overview

‎docs/kratos/manage-identities/01_overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: overview
33
title: What is an identity in Ory?
4-
sidebar_label: Overview
4+
sidebar_label: Identity management
55
---
66

77
# Identity model

‎docs/kratos/mfa/01_overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: overview
33
title: Multi-factor authentication in Ory Network
4-
sidebar_label: Overview
4+
sidebar_label: Multi-factor authentication
55
---
66

77
# Overview

‎docs/kratos/mfa/30_sms.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: mfa-via-sms
2+
id: sms
33
title: SMS and Email 2FA
44
sidebar_label: SMS and Email
55
---

‎docs/kratos/organizations/organizations.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: organizations
3-
title: Organizations and B2B Single Sign-On
3+
title: B2B Single Sign-On
44
---
55

66
:::info

‎docs/kratos/passwordless/00_overview.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: passwordless
2+
id: overview
33
title: Use passwordless WebAuthN to protect against phishing attacks
4-
sidebar_label: Overview
4+
sidebar_label: Passwordless
55
---
66

77
Read this document if:

‎docs/kratos/passwordless/06_code.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: one-time-code
2+
id: code
33
title: Passwordless authentication with one-time code
44
sidebar_label: One-time code
55
---

‎docs/kratos/sdk/05_go.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: go
3-
title: Go
3+
title: Ory Identities Go
44
---
55

66
```mdx-code-block

‎docs/kratos/self-service/flows/account-recovery-password-reset.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: account-recovery-password-reset
33
title: Recover access to accounts and perform password reset
4-
sidebar_label: Account recovery
4+
sidebar_label: Recovery
55
---
66

77
# Account recovery and password reset

‎docs/kratos/self-service/flows/user-login.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: user-login
3-
title: User login
3+
title: Login
44
---
55

66
import Mermaid from "@site/src/theme/Mermaid"
@@ -141,7 +141,7 @@ example) to the URL configured here:
141141
]}>
142142
<TabItem value="oc">
143143

144-
The Ory Network offers a default UI implementation. Visit [Bring Your Own UI](../../bring-your-own-ui/custom-ui-overview) to learn
144+
The Ory Network offers a default UI implementation. Visit [Bring Your Own UI](../../bring-your-own-ui/01_overview.mdx) to learn
145145
how to implement a custom UI.
146146

147147
</TabItem>

‎docs/kratos/self-service/flows/user-logout.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: user-logout
3-
title: User logout
3+
title: Logout
44
---
55

66
```mdx-code-block

‎docs/kratos/self-service/flows/user-registration.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: user-registration
3-
title: User registration
3+
title: Registration
44
---
55

66
import Mermaid from "@site/src/theme/Mermaid"
@@ -153,7 +153,7 @@ example) to the configured registration URL.
153153
]}>
154154
<TabItem value="oc">
155155

156-
The Ory Network offers a default UI implementation. Visit [Bring Your Own UI](../../bring-your-own-ui/custom-ui-overview) to learn
156+
The Ory Network offers a default UI implementation. Visit [Bring Your Own UI](../../bring-your-own-ui/01_overview.mdx) to learn
157157
how to implement a custom UI.
158158

159159
</TabItem>

‎docs/kratos/self-service/flows/user-settings.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: user-settings
3-
title: User settings and profile updates
3+
title: Settings and profile updates
44
---
55

66
import Mermaid from "@site/src/theme/Mermaid"
@@ -278,7 +278,7 @@ example) to the configured settings URL.
278278
<TabItem value="oc">
279279

280280
The Ory Network offers a default UI implementation. Visit
281-
[Bring Your Own UI](https://www.ory.sh/docs/kratos/bring-your-own-ui/custom-ui-overview) to learn how to implement a custom UI.
281+
[Bring Your Own UI](https://www.ory.sh/docs/kratos/bring-your-own-ui/01_overview.mdx) to learn how to implement a custom UI.
282282

283283
</TabItem>
284284
<TabItem value="oss">

0 commit comments

Comments
 (0)