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

fix: new sidebarv2 #1823

Merged
merged 75 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
3b56242
chore: update docusaurus to 3.X
jonas-jonas Mar 22, 2024
f85c4b3
chore: move the message descriptions to their own file
jonas-jonas Apr 19, 2024
2f9b137
chore: format
jonas-jonas Apr 20, 2024
d67298e
Merge branch 'master' into jonas-jonas/moveMessageDescriptionToOwnFile
jonas-jonas Apr 20, 2024
ad77764
Merge remote-tracking branch 'origin/master' into jonas-jonas/updateD…
jonas-jonas Apr 20, 2024
860972f
Merge remote-tracking branch 'origin/jonas-jonas/moveMessageDescripti…
jonas-jonas Apr 20, 2024
5b8afdd
Merge remote-tracking branch 'origin/master' into jonas-jonas/updateD…
jonas-jonas Apr 24, 2024
7e29b39
Merge remote-tracking branch 'origin/master' into jonas-jonas/updateD…
jonas-jonas Apr 24, 2024
c5496fe
fix: compilation issues
jonas-jonas Apr 24, 2024
5ff80ab
chore: formatting
jonas-jonas Apr 24, 2024
90008f7
chore: upgrade versions in workflows
jonas-jonas Apr 24, 2024
424981f
Merge branch 'master' into jonas-jonas/updateDocusaurus
jonas-jonas Apr 25, 2024
32c3d83
chore: downgrade mermaid to 9.3
jonas-jonas Apr 30, 2024
656db1a
chore: format
jonas-jonas Apr 30, 2024
1a411a4
chore: add sharp??
jonas-jonas Apr 30, 2024
40bf8e9
chore: format
jonas-jonas May 2, 2024
95fba87
Merge remote-tracking branch 'origin/master' into jonas-jonas/updateD…
jonas-jonas May 31, 2024
c5ea299
chore: u
jonas-jonas May 31, 2024
092d0cd
fix: visual regressions
jonas-jonas May 31, 2024
40f5dad
chore: format
jonas-jonas Jun 3, 2024
02f0bc1
Merge branch 'master' into jonas-jonas/updateDocusaurus
jonas-jonas Jun 10, 2024
ec270a6
chore: cleanup
jonas-jonas Jun 11, 2024
a762e55
feat(wip): rework sidebar
jonas-jonas Jun 14, 2024
d121664
fix: new sidebar
vinckr Jun 19, 2024
ba7935b
fix: new sidebar
vinckr Jun 20, 2024
d93be0d
fix: links
vinckr Jun 20, 2024
1dc2071
fix: new sidebar
vinckr Jun 20, 2024
8e82548
fix: new sidebar
vinckr Jun 20, 2024
ce82f51
fix: new sidebar add oauth2
vinckr Jun 20, 2024
ef0c360
fix: add keto and reorder a bit
vinckr Jun 20, 2024
02254bc
fix: new sidebar
vinckr Jun 20, 2024
e6cd61f
chore: merge master
vinckr Jun 26, 2024
08cb9b8
chore: update docusaurus to 3.X
jonas-jonas Mar 22, 2024
0a9e1cd
chore: move the message descriptions to their own file
jonas-jonas Apr 19, 2024
8a8ad18
chore: format
jonas-jonas Apr 20, 2024
e2dd24f
fix: compilation issues
jonas-jonas Apr 24, 2024
5b4f8df
chore: formatting
jonas-jonas Apr 24, 2024
b51de17
chore: downgrade mermaid to 9.3
jonas-jonas Apr 30, 2024
ad0b32b
chore: format
jonas-jonas Apr 30, 2024
10da34d
fix: visual regressions
jonas-jonas May 31, 2024
fd2c4a5
feat(wip): rework sidebar
jonas-jonas Jun 14, 2024
a729751
chore: format
vinckr Jun 26, 2024
2c08226
chore: format
vinckr Jun 27, 2024
b3fc4b9
fix: build
vinckr Jun 27, 2024
8f77d6e
fix: sidebar
vinckr Jun 27, 2024
5f2a383
chore: fix build
vinckr Jun 27, 2024
1609c76
chore: fix build
vinckr Jun 27, 2024
e7cc5e8
chore: fix build
vinckr Jun 27, 2024
800cfef
Merge branch 'master' into vinckr/newSidebar
vinckr Jun 27, 2024
e77851a
chore: fix build
vinckr Jun 27, 2024
9d7725c
chore: adjust the new sidebar (#1788)
jonas-jonas Jul 15, 2024
8817ca4
Merge branch 'master' into vinckr/newSidebar
vinckr Jul 15, 2024
61c73ff
chore: remove licenses for now
vinckr Jul 25, 2024
d605d45
fix: ory identities overview
vinckr Jul 25, 2024
bc3b9f6
chore: remove unneeded overviews
vinckr Jul 25, 2024
6500960
fix: migration tutorial
vinckr Jul 25, 2024
0c74cb1
fix: add self-hosting and top bar items
vinckr Jul 25, 2024
dff03c6
fix: merge identities intro with kratos intro
vinckr Jul 25, 2024
cae5342
fix: simply Ory CLI reference sidebar
vinckr Jul 25, 2024
f609add
fix: simply Ory CLI reference sidebar
vinckr Jul 25, 2024
6172e7a
fix: simply Ory CLI reference sidebar
vinckr Jul 25, 2024
b5e7632
fix: simply Ory CLI reference sidebar
vinckr Jul 25, 2024
6a36ca4
fix: broken link
vinckr Jul 25, 2024
ea6fc3d
chore: fix broken links
vinckr Jul 25, 2024
9c47636
chore: add missing docs to sidebar
vinckr Aug 12, 2024
cca8e46
u
vinckr Aug 12, 2024
4dee1df
u
vinckr Aug 12, 2024
098ad90
chore: fix broken link
vinckr Aug 12, 2024
b8939b2
chore: fix merge conflicts
vinckr Aug 22, 2024
f113867
chore: fix merge conflicts
vinckr Aug 22, 2024
3c217c7
Merge branch 'master' into vinckr/newSidebarFINAL
vinckr Aug 26, 2024
359e278
Merge branch 'master' into vinckr/newSidebarFINAL
vinckr Aug 30, 2024
3e20cb0
chore: format
vinckr Aug 30, 2024
3d39eeb
fix: sdk quickstarts
vinckr Aug 30, 2024
5466017
chore: move oauth2 guides
vinckr Aug 30, 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
3 changes: 3 additions & 0 deletions arrow-left.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/account-experience/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: index
title: Account-Experience Overview
sidebar_label: Account-Experience
title: Account Experience Overview
sidebar_label: Account Experience
---

The Ory Account Experience is the default user interface for all self-service screens like login, registration, or consent. It can
Expand Down
4 changes: 2 additions & 2 deletions docs/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: index
title: gRPC + REST API Overview
sidebar_label: Overview
sidebar_label: API overview
---

```mdx-code-block
Expand All @@ -21,4 +21,4 @@ Ory Permissions supports gRPC APIs.
## CORS

All Ory public APIs support CORS. For details on how to configure CORS for Ory Network, please refer to the
[CORS documentation](../guides/cors.mdx). For self-hosted, the CORS configuration is part of the configuration file.
[CORS documentation](../guides/cors.mdx). For self-hosted Ory, the CORS configuration is part of the configuration file.
2 changes: 1 addition & 1 deletion docs/getting-started/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: overview
title: Overview
title: Quickstarts & Tutorials
---

Are you looking for an example to just get started? Check out all available examples!
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/cli/01_installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: installation
title: Installation
---

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

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

## Installation

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

### macOS

Run this command to install the CLI using Homebrew:
Run this command to install the Ory CLI using Homebrew:

```shell
brew install ory/tap/cli
Expand All @@ -31,7 +31,7 @@ ory help

### Linux

Ory CLI works on all Linux distributions. Run this command to install:
The Ory CLI works on all Linux distributions. Run this command to install:

```shell
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -b . ory
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/cli/15_config-identity-service.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: identity-cli
vinckr marked this conversation as resolved.
Show resolved Hide resolved
title: Configure Ory Identities
id: config-identity-service
title: Ory Identities CLI
---

Using the Ory CLI, you can quickly adjust the configuration of the Ory Identities and apply config from the Ory Network
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: integrate-with-ory-cloud-through-webhooks
title: Trigger custom logic and integrate with external systems with webhooks
sidebar_label: Webhooks
sidebar_label: Ory Actions
---

Ory Actions supports webhooks, which are HTTP callbacks that can be triggered by specific events in your Ory-powered application.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/ip-allowlist.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: allowlist
vinckr marked this conversation as resolved.
Show resolved Hide resolved
id: ip-allowlist
title: Configure Ory Network IP addresses as allow list
sidebar_label: Ory Network IP Addresses
---
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/rate-limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Each of these policies incorporates two types of rate limits:
| | `/relation-tuples/check` | 80 | 1800 |
| | `GET /admin/identities` | 10 | 300 |
| | `*` | 40 | 900 |
| **Staging** | `/sessions/whoami` | 10 | 300 |
| **Staging** | `/sessions/whoami` | 10 | 30 |
| | `/admin/oauth2/introspect` | 10 | 300 |
| | `/relation-tuples/check` | 10 | 300 |
| | `GET /admin/identities` | 1 | 10 |
Expand Down
12 changes: 6 additions & 6 deletions docs/hydra/sdk/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: go
title: Go
title: Ory OAuth2 Go
---

```mdx-code-block
import CodeBlock from "@theme/CodeBlock"
import { useLatestTag } from '@site/src/hooks'
```

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

:::info

Expand All @@ -17,11 +17,11 @@ Missing an example? Please create a
here.

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

:::

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

:::danger

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

## Making requests

The following code examples show how to make requests to the Ory Hydra API.
The following code examples show how to make requests to the Ory OAuth2 API.

### CreateOAuth2Client and ListOAuth2Clients

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

- [OAuth2Api API](https://github.com/ory/hydra-client-go/blob/master/docs/OAuth2Api.md)
- [OidcApi API](https://github.com/ory/hydra-client-go/blob/master/docs/OidcApi.md)
- [OIDCApi API](https://github.com/ory/hydra-client-go/blob/master/docs/OidcApi.md)
15 changes: 6 additions & 9 deletions docs/hydra/sdk/10_js.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
---
id: js
title: JavaScript
title: Ory OAuth2 JavaScript
---

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

:::info

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

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

:::

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

const hydraPublic = new PublicApi(
const oryPublic = new PublicApi(
new Configuration({
basePath: "https://public.hydra:4444/",
basePath: "https://$PROJECT_SLUG.projects.oryapis.com/",
}),
)

const hydraAdmin = new AdminApi(
const oryAdmin = new AdminApi(
new Configuration({
basePath: "https://public.hydra:4445/",
basePath: "https://$PROJECT_SLUG.projects.oryapis.com/",
}),
)
```
2 changes: 1 addition & 1 deletion docs/hydra/self-hosted/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: go
title: Go
title: Ory Hydra Go
---

In this document you can find code examples for the Ory Hydra Go SDK.
Expand Down
2 changes: 1 addition & 1 deletion docs/identities/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: index
title: Introduction to Ory Identities
sidebar_label: Introduction
sidebar_label: Ory Identities
---

Ory Identities is an API-first identity and user management system built on top of the widely deployed open-source
Expand Down
2 changes: 1 addition & 1 deletion docs/keto/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: index
title: Introduction to Ory Permissions
sidebar_label: Introduction
sidebar_label: Ory Permissions
---

# Introduction
Expand Down
2 changes: 1 addition & 1 deletion docs/keto/sdk/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: go
title: Go
title: Ory Permissions Go
---

```mdx-code-block
Expand Down
4 changes: 2 additions & 2 deletions docs/keto/sdk/10_python.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: python
title: Python
title: Ory Permissions Python
---

```mdx-code-block
Expand All @@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem"
import CodeBlock from "@theme/CodeBlock"
```

In this document you can find code examples for the Ory Python SDK.
In this document you can find code examples for the Ory Permissions Python SDK.

:::info

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/bring-your-own-ui/01_overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: custom-ui-overview
id: index
vinckr marked this conversation as resolved.
Show resolved Hide resolved
title: Custom UI overview
sidebar_label: Overview
---
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/concepts/credentials.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: credentials
title: Overview
title: Credentials
---

Each identity has one or more credentials associated with it:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: username-email-password
title: Login and registration using passwords
sidebar_label: Overview
sidebar_label: Password
---

The combination of identifier (username, email, phone number) and password is the oldest and most common way to authenticate users
Expand Down
1 change: 0 additions & 1 deletion docs/kratos/hooks/01_configure-hooks.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
id: configure-hooks
title: Ory Actions
sidebar_label: Overview
---

# Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/manage-identities/01_overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: overview
title: What is an identity in Ory?
sidebar_label: Overview
sidebar_label: Identity management
---

# Identity model
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/mfa/01_overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: overview
title: Multi-factor authentication in Ory Network
sidebar_label: Overview
sidebar_label: Multi-factor authentication
---

# Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/mfa/30_sms.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: mfa-via-sms
id: sms
vinckr marked this conversation as resolved.
Show resolved Hide resolved
title: SMS and Email 2FA
sidebar_label: SMS and Email
---
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/organizations/organizations.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: organizations
title: Organizations and B2B Single Sign-On
title: B2B Single Sign-On
---

:::info
Expand Down
4 changes: 2 additions & 2 deletions docs/kratos/passwordless/00_overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: passwordless
id: overview
vinckr marked this conversation as resolved.
Show resolved Hide resolved
title: Use passwordless WebAuthN to protect against phishing attacks
sidebar_label: Overview
sidebar_label: Passwordless
---

Read this document if:
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/passwordless/06_code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: one-time-code
id: code
vinckr marked this conversation as resolved.
Show resolved Hide resolved
title: Passwordless authentication with one-time code
sidebar_label: One-time code
---
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/sdk/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: go
title: Go
title: Ory Identities Go
---

```mdx-code-block
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: account-recovery-password-reset
title: Recover access to accounts and perform password reset
sidebar_label: Account recovery
sidebar_label: Recovery
---

# Account recovery and password reset
Expand Down
4 changes: 2 additions & 2 deletions docs/kratos/self-service/flows/user-login.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: user-login
title: User login
title: Login
---

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

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

</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/self-service/flows/user-logout.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: user-logout
title: User logout
title: Logout
---

```mdx-code-block
Expand Down
4 changes: 2 additions & 2 deletions docs/kratos/self-service/flows/user-registration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: user-registration
title: User registration
title: Registration
---

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

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

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/kratos/self-service/flows/user-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: user-settings
title: User settings and profile updates
title: Settings and profile updates
---

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

The Ory Network offers a default UI implementation. Visit
[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.
[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.

</TabItem>
<TabItem value="oss">
Expand Down
Loading
Loading