From 6bf524a3563bff64074069bc00fd9f0635694bf6 Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Tue, 24 Sep 2024 13:41:13 +0200 Subject: [PATCH 1/2] chore: synchronize workspaces --- docs/api/index.mdx | 2 +- docs/reference/api.mdx | 2 +- docs/sdk.mdx | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/index.mdx b/docs/api/index.mdx index d03063117..9a0443406 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -1,7 +1,7 @@ --- id: index title: gRPC + REST API Overview -sidebar_label: API overview +sidebar_label: APIs --- ```mdx-code-block diff --git a/docs/reference/api.mdx b/docs/reference/api.mdx index fed182456..af8192b6d 100644 --- a/docs/reference/api.mdx +++ b/docs/reference/api.mdx @@ -2,7 +2,7 @@ id: api hide_title: true title: Ory REST HTTP API Documentation -sidebar_label: REST API Reference +sidebar_label: REST API --- ```mdx-code-block diff --git a/docs/sdk.mdx b/docs/sdk.mdx index f880c7f7d..29057e581 100644 --- a/docs/sdk.mdx +++ b/docs/sdk.mdx @@ -1,7 +1,7 @@ --- id: sdk -title: Ory SDK -sidebar_label: Ory SDK +title: Software Development Kits (SDKs) for Ory +sidebar_label: SDKs --- The Ory SDK allows for integration with Ory services, including **Ory Identities**, **Ory Permissions**, and **Ory OAuth2**. @@ -9,7 +9,7 @@ The Ory SDK allows for integration with Ory services, including **Ory Identities Before using the SDK, consult the Ory [REST](./reference/api.mdx) API documentation, which includes code samples and examples for various programming languages. -This SDK is intended to be used with Ory Network. +This SDK is intended to be used with Ory Network. For self-hosting Ory services use the respective client. Read more in the [self-hosting documentation](https://www.ory.sh/docs/ecosystem/projects) for each service under **Reference/SDK**. @@ -37,7 +37,7 @@ Ory publishes SDKs for popular languages in their respective package repositorie To view the source code for the generated Ory SDKs, visit the GitHub repository: [Generated SDKs for Ory](https://github.com/ory/sdk/tree/master/clients/client) -Missing your programming language? +Missing your programming language? [Create an issue](https://github.com/ory/sdk/issues) and help the Ory team build, test, and publish the SDK for your programming language! From 5e324c8f8a25b968cd3a54d1379b8eeb69bc549d Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:32:52 +0200 Subject: [PATCH 2/2] docs: sidebar adjustments --- docs/guides/permissions/overview.mdx | 1 - docs/hydra/sdk/05_go.mdx | 3 +- docs/hydra/sdk/10_js.mdx | 3 +- docs/keto/sdk/05_go.mdx | 3 +- docs/keto/sdk/10_python.mdx | 3 +- docs/kratos/sdk/05_go.mdx | 3 +- docs/sdk.mdx | 8 ++- src/sidebar.ts | 81 +++++++++++++++------------- 8 files changed, 56 insertions(+), 49 deletions(-) diff --git a/docs/guides/permissions/overview.mdx b/docs/guides/permissions/overview.mdx index 3991519f4..9276f7674 100644 --- a/docs/guides/permissions/overview.mdx +++ b/docs/guides/permissions/overview.mdx @@ -1,7 +1,6 @@ --- id: overview title: Get started with Permissions in the Ory Network -sidebar_label: Permissions --- # Get started with Ory Permissions diff --git a/docs/hydra/sdk/05_go.mdx b/docs/hydra/sdk/05_go.mdx index 26af7eaf8..8003a62fb 100644 --- a/docs/hydra/sdk/05_go.mdx +++ b/docs/hydra/sdk/05_go.mdx @@ -1,6 +1,7 @@ --- id: go -title: Ory OAuth2 Go +title: Ory OAuth2 & OpenID Connect Go SDK +sidebar_label: Go SDK --- ```mdx-code-block diff --git a/docs/hydra/sdk/10_js.mdx b/docs/hydra/sdk/10_js.mdx index a63b58b88..29a1ddaa9 100644 --- a/docs/hydra/sdk/10_js.mdx +++ b/docs/hydra/sdk/10_js.mdx @@ -1,6 +1,7 @@ --- id: js -title: Ory OAuth2 JavaScript +title: Ory OAuth2 & OpenID Connect JavaScript SDK +sidebar_label: JavaScript SDK --- In this document you can find code examples for the Ory OAuth2 JavaScript SDK. diff --git a/docs/keto/sdk/05_go.mdx b/docs/keto/sdk/05_go.mdx index 1254d9ef7..25b6c52c1 100644 --- a/docs/keto/sdk/05_go.mdx +++ b/docs/keto/sdk/05_go.mdx @@ -1,6 +1,7 @@ --- id: go -title: Ory Permissions Go +title: Ory Permissions Go SDK +sidebar_label: Go SDK --- ```mdx-code-block diff --git a/docs/keto/sdk/10_python.mdx b/docs/keto/sdk/10_python.mdx index 0fe91ef31..b9f5dba5c 100644 --- a/docs/keto/sdk/10_python.mdx +++ b/docs/keto/sdk/10_python.mdx @@ -1,6 +1,7 @@ --- id: python -title: Ory Permissions Python +title: Ory Permissions Python SDK +sidebar_label: Python SDK --- ```mdx-code-block diff --git a/docs/kratos/sdk/05_go.mdx b/docs/kratos/sdk/05_go.mdx index 4ab59e600..0da1405e5 100644 --- a/docs/kratos/sdk/05_go.mdx +++ b/docs/kratos/sdk/05_go.mdx @@ -1,6 +1,7 @@ --- id: go -title: Ory Identities Go +title: Ory Identity Management Go SDK +sidebar_label: Go SDK --- ```mdx-code-block diff --git a/docs/sdk.mdx b/docs/sdk.mdx index 29057e581..137eebf68 100644 --- a/docs/sdk.mdx +++ b/docs/sdk.mdx @@ -9,8 +9,7 @@ The Ory SDK allows for integration with Ory services, including **Ory Identities Before using the SDK, consult the Ory [REST](./reference/api.mdx) API documentation, which includes code samples and examples for various programming languages. -This SDK is intended to be used with Ory Network. -For self-hosting Ory services use the respective client. Read more in the +This SDK is intended to be used with Ory Network. For self-hosting Ory services use the respective client. Read more in the [self-hosting documentation](https://www.ory.sh/docs/ecosystem/projects) for each service under **Reference/SDK**. ## Download the SDK @@ -37,9 +36,8 @@ Ory publishes SDKs for popular languages in their respective package repositorie To view the source code for the generated Ory SDKs, visit the GitHub repository: [Generated SDKs for Ory](https://github.com/ory/sdk/tree/master/clients/client) -Missing your programming language? -[Create an issue](https://github.com/ory/sdk/issues) and help the Ory team build, test, and publish the SDK for your programming -language! +Missing your programming language? [Create an issue](https://github.com/ory/sdk/issues) and help the Ory team build, test, and +publish the SDK for your programming language! ### SDK Backwards compatibility diff --git a/src/sidebar.ts b/src/sidebar.ts index 473bb8327..ccdc769a8 100644 --- a/src/sidebar.ts +++ b/src/sidebar.ts @@ -75,7 +75,6 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => { return [ ...items, - "getting-started/local-development", { type: "category", label: "User authentication", @@ -101,40 +100,36 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => { }, { type: "category", - label: "OAuth2 and OpenID Connect", + label: "Permissions and relationships", collapsed: false, collapsible: false, link: { type: "doc", - id: "guides/oauth2-openid-connect", + id: "guides/permissions/overview", }, items: flat ? [] - : [ - "getting-started/ory-network-oauth2", - "getting-started/oauth2-openid/expressjs", - ], + : ["keto/examples/olymp-file-sharing", "keto/guides/rbac"], }, { type: "category", - label: "Permissions", + label: "OAuth2 and OpenID", collapsed: false, collapsible: false, link: { type: "doc", - id: "guides/permissions/overview", + id: "guides/oauth2-openid-connect", }, items: flat ? [] : [ - "keto/examples/olymp-file-sharing", - "keto/guides/rbac", - "guides/gitops", + "getting-started/ory-network-oauth2", + "getting-started/oauth2-openid/expressjs", ], }, { type: "category", - label: "SDK quickstarts", + label: "Software Development Kits", collapsed: false, collapsible: false, link: { @@ -144,11 +139,21 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => { items: flat ? [] : [ - "kratos/sdk/go", - "hydra/sdk/js", - "hydra/sdk/go", - "keto/sdk/go", - "keto/sdk/python", + { + type: "category", + label: "Identity Management", + items: ["kratos/sdk/go"], + }, + { + type: "category", + label: "OAuth2 & OpenID Connect", + items: ["hydra/sdk/js", "hydra/sdk/go"], + }, + { + type: "category", + label: "Permissions", + items: ["keto/sdk/go", "keto/sdk/python"], + }, ], }, ] @@ -163,7 +168,7 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => { ...items, { type: "category", - label: "Login and registration", + label: "User authentication", collapsed: false, collapsible: false, link: { @@ -173,6 +178,7 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => { items: flat ? [] : [ + "getting-started/local-development", "kratos/concepts/credentials/username-email-password", "kratos/passwordless/one-time-code", "kratos/passwordless/passkeys", @@ -230,33 +236,16 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => { }, { type: "category", - label: "Customize user experience", + label: "Customized auth flows", items: [ "identities/sign-in/two-step-registration", "identities/sign-in/identifier-first-authentication", "identities/sign-in/login-hint", - "getting-started/custom-ui", "identities/sign-in/actions", ], }, ], }, - { - type: "category", - label: "Emails and SMS", - collapsed: false, - collapsible: false, - link: { - type: "doc", - id: "guides/email-sms", - }, - items: flat - ? [] - : [ - "kratos/emails-sms/sending-emails-smtp", - "kratos/emails-sms/sending-sms", - ], - }, { type: "category", label: "Ory Actions", @@ -329,6 +318,22 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => { "kratos/manage-identities/best-practices", ], }, + { + type: "category", + label: "Emails and SMS", + collapsed: false, + collapsible: false, + link: { + type: "doc", + id: "guides/email-sms", + }, + items: flat + ? [] + : [ + "kratos/emails-sms/sending-emails-smtp", + "kratos/emails-sms/sending-sms", + ], + }, { type: "category", label: "Session management", @@ -351,7 +356,7 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => { }, { type: "category", - label: "Customized UI", + label: "Build your own UI", collapsed: false, collapsible: false, link: {