diff --git a/docs/docs/apis/introduction.mdx b/docs/docs/apis/introduction.mdx index 3fd31cadc..c17048083 100644 --- a/docs/docs/apis/introduction.mdx +++ b/docs/docs/apis/introduction.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: API Reference Overview +sidebar_label: Overview --- import { ApiCard } from "../../src/components/apicard"; diff --git a/docs/docs/concepts/eventstore/overview.md b/docs/docs/concepts/eventstore/overview.md index a3e1719cb..fd564ce96 100644 --- a/docs/docs/concepts/eventstore/overview.md +++ b/docs/docs/concepts/eventstore/overview.md @@ -1,5 +1,6 @@ --- -title: Overview +title: Eventstore +sidebar_label: Overview --- ZITADEL is built on the [Event Sourcing pattern](../architecture/software), where changes are stored as events in an Event Store. diff --git a/docs/docs/concepts/introduction.mdx b/docs/docs/concepts/introduction.mdx deleted file mode 100644 index ed94e6644..000000000 --- a/docs/docs/concepts/introduction.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Introduction ---- - -This part of the **ZITADEL** documentation contains ZITADEL specific or general concepts required to understand the system or our guides. - -![Overview](/img/concepts/objects/object_overview.png) - -This overview shows the general structure of ZITADEL. -You will find more detailed explanations around the different concepts in the following sections. \ No newline at end of file diff --git a/docs/docs/concepts/structure/instance.mdx b/docs/docs/concepts/structure/instance.mdx index 7c22c6e45..d407ab679 100644 --- a/docs/docs/concepts/structure/instance.mdx +++ b/docs/docs/concepts/structure/instance.mdx @@ -14,7 +14,10 @@ which in turn can represent your own company (e.g. departments), your business c Read more about how to configure your instance in our [instance guide](/guides/manage/console/instance-settings). -![Two instances with each organizations in it using the same database](/img/concepts/objects/instances.png) +![Overview](/img/concepts/objects/object_overview.png) + +This overview shows the general structure of ZITADEL. +You will find more detailed explanations around the different concepts in the following sections. ## Multiple Virtual Instances @@ -24,3 +27,5 @@ Nevertheless, you can add more virtual instances via the [system API](/apis/reso This is useful if you have business customers, which in turn have their business customers with self service and custom domain demands. By providing a virtual ZITADEL instances, your customers have all the customization options available in ZITADEL. Scaling ZITADEL instances virtually enables you to easily distribute your limited compute resources to all your customers. + +![Two instances with each organizations in it using the same database](/img/concepts/objects/instances.png) diff --git a/docs/docs/concepts/structure/overview.md b/docs/docs/concepts/structure/overview.md deleted file mode 100644 index c2d6d2315..000000000 --- a/docs/docs/concepts/structure/overview.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Overview ---- - -This overview shows the general structure of ZITADEL. - -![Overview](/img/concepts/objects/object_overview.png) - -More details on the specific objects: - -- [Instance](./instance) -- [Organizations](./organizations) -- [Policies/Settings](./policies) -- [Projects](./projects) -- [Applications](./applications) -- [Granted Projects](./granted_projects) -- [Users](./users) diff --git a/docs/docs/examples/introduction.mdx b/docs/docs/examples/introduction.mdx index 873bf42a9..46001fde3 100644 --- a/docs/docs/examples/introduction.mdx +++ b/docs/docs/examples/introduction.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: Overview of examples, quickstarts, and SDKs +sidebar_label: Overview --- Our examples cover a range of programming languages and frameworks, so no matter what you're into, we've got you covered. diff --git a/docs/docs/guides/manage/cloud/overview.md b/docs/docs/guides/manage/cloud/overview.md deleted file mode 100644 index 8c144f571..000000000 --- a/docs/docs/guides/manage/cloud/overview.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Overview ---- - -The ZITADEL customer Portal is used to manage all your different ZITADEL instances. -You can also manage your subscriptions, billing, newsletters and support requests. - -More details on the specific objects: - -- [Getting Started](./start) -- [Instances](./instances) -- [Billing](./billing) -- [Users](./users) -- [Support](./support) diff --git a/docs/docs/guides/manage/console/overview.mdx b/docs/docs/guides/manage/console/overview.mdx index 9553f06b5..3e515ffa0 100644 --- a/docs/docs/guides/manage/console/overview.mdx +++ b/docs/docs/guides/manage/console/overview.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: Console +sidebar_label: Overview --- ## What is console? diff --git a/docs/docs/guides/manage/customize/texts.md b/docs/docs/guides/manage/customize/texts.md index 1609e2a93..d09011595 100644 --- a/docs/docs/guides/manage/customize/texts.md +++ b/docs/docs/guides/manage/customize/texts.md @@ -5,6 +5,7 @@ title: Customized Texts You are able to customize the texts used from ZITADEL. This is possibly on the instance or organization level. ## Message Texts + Sometimes the users will get an email or phone message from ZITADEL (e.g Password Reset Request). ZITADEL already has some good standard texts, but maybe you would like to customize it for your organization. @@ -29,7 +30,7 @@ You will see the default texts in the input field and you can overwrite them by If you don't like your customization anymore click the "reset policy" button. All your settings will be removed and the default settings of the system will trigger. -## Internationalization +## Internationalization / i18n ZITADEL is available in the following languages diff --git a/docs/docs/guides/overview.mdx b/docs/docs/guides/overview.mdx index 18bb541ca..df7402a16 100644 --- a/docs/docs/guides/overview.mdx +++ b/docs/docs/guides/overview.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: Documentation +sidebar_label: Overview --- Most applications need to know the identity of a user for access control, to securely store their data in the cloud, and provide the same personalized experience across all of the user's devices. diff --git a/docs/docs/sdks/introduction.mdx b/docs/docs/sdks/introduction.mdx deleted file mode 100644 index 96825dfa4..000000000 --- a/docs/docs/sdks/introduction.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: Overview ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import { Card, CardWrapper } from "../../src/components/card"; - -Get started with ZITADEL quickly by reading a quickstart or by cloning a [ZITADEL example](https://github.com/search?q=topic%3Aexamples+org%3Azitadel) repo. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## Clone a sample project - - - - - - - - - -## Libraries - -| Language | Description | Link | -| -------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| Go | Go client library for ZITADEL. | [https://github.com/zitadel/zitadel-go](https://github.com/zitadel/zitadel-go) | -| .Net | Authentication / Authorization library written in dotnet for the asp.net web application package. | [https://github.com/zitadel/zitadel-net](https://github.com/zitadel/zitadel-net) | -| Dart | Dart library for ZITADEL, contains gRPC and API access elements. | [https://github.com/zitadel/zitadel-dart](https://github.com/zitadel/zitadel-dart) | -| Elixir | API Client for the ZITADEL API. | [https://github.com/jshmrtn/zitadel_api](https://github.com/jshmrtn/zitadel_api) | diff --git a/docs/docs/self-hosting/deploy/overview.mdx b/docs/docs/self-hosting/deploy/overview.mdx index c9acfa57a..dfdad7ae4 100644 --- a/docs/docs/self-hosting/deploy/overview.mdx +++ b/docs/docs/self-hosting/deploy/overview.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: Deploy ZITADEL +sidebar_label: Overview --- Choose your platform and run ZITADEL with the most minimal configuration possible. diff --git a/docs/docs/support/trainings/introduction.md b/docs/docs/support/trainings/introduction.md index 2c3554366..270d6e906 100644 --- a/docs/docs/support/trainings/introduction.md +++ b/docs/docs/support/trainings/introduction.md @@ -1,5 +1,6 @@ --- -title: Introduction +title: Trainings +sidebar_label: Introduction --- The following pages describe the the trainings provided by ZITADEL. These trainings are intended for onboarding and during the course of a Support Program. diff --git a/docs/sidebars.js b/docs/sidebars.js index f282953bb..3f73a8ca9 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -57,8 +57,14 @@ module.exports = { { type: "category", label: "Cloud", + link: { + type: "generated-index", + title: "Overview", + slug: "guides/manage/cloud/overview", + description: + "Our customer portal is used to manage all your ZITADEL instances. You can also manage your subscriptions, billing, newsletters and support requests.", + }, items: [ - "guides/manage/cloud/overview", "guides/manage/cloud/start", "guides/manage/cloud/instances", "guides/manage/cloud/billing", @@ -268,8 +274,14 @@ module.exports = { type: "category", label: "Concepts", collapsed: true, + link: { + type: "generated-index", + title: "Concepts and Features", + slug: "concepts", + description: + "This part of our documentation contains ZITADEL specific or general concepts required to understand the system or our guides.", + }, items: [ - "concepts/introduction", "concepts/structure/instance", "concepts/structure/organizations", "concepts/structure/projects",