mirror of
https://github.com/zitadel/zitadel.git
synced 2025-05-28 12:48:21 +00:00
docs: optimize titles for search (#5880)
* docs: optimize titles for search * wip * trainings * API * trainings * orphaned: structure overview * eventstore * examples * docs overview * cloud * console * orphaned: sdks * deploy
This commit is contained in:
mffap
GitHub
parent
f4b166a935
commit
b6b229ed4f
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Overview
|
||||
title: API Reference Overview
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
import { ApiCard } from "../../src/components/apicard";
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
This overview shows the general structure of ZITADEL.
|
||||
You will find more detailed explanations around the different concepts in the following sections.
|
||||
@ -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).
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
title: Overview
|
||||
---
|
||||
|
||||
This overview shows the general structure of ZITADEL.
|
||||
|
||||
|
||||
|
||||
More details on the specific objects:
|
||||
|
||||
- [Instance](./instance)
|
||||
- [Organizations](./organizations)
|
||||
- [Policies/Settings](./policies)
|
||||
- [Projects](./projects)
|
||||
- [Applications](./applications)
|
||||
- [Granted Projects](./granted_projects)
|
||||
- [Users](./users)
|
||||
@ -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.
|
||||
|
||||
@ -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)
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Overview
|
||||
title: Console
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
## What is console?
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="app" label="Web · Native applications" default>
|
||||
<CardWrapper>
|
||||
<Card
|
||||
link="/docs/examples/login/angular"
|
||||
imageSource="/docs/img/tech/angular.svg"
|
||||
title="Angular"
|
||||
description="Add the user login to your application and query some data from the userinfo endpoint"
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/login/react"
|
||||
imageSource="/docs/img/tech/react.png"
|
||||
title="React"
|
||||
description="Logs into your application and queries some data from the userinfo endpoint"
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/login/flutter"
|
||||
imageSource="/docs/img/tech/flutter.svg"
|
||||
title="Flutter"
|
||||
description="Mobile Application working for iOS and Android that authenticates your user."
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/login/nextjs"
|
||||
imageSource="/docs/img/tech/nextjs.svg"
|
||||
title="NextJS"
|
||||
description="A simple application to log into your user account and query some data from User endpoint."
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/login/nextjs-b2b"
|
||||
imageSource="/docs/img/tech/nextjs.svg"
|
||||
title="NextJS B2B Scenario"
|
||||
description="An application to showcase your user account having multiple organizations and the use of Personal Access Tokens."
|
||||
/>
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
<TabItem value="apis" label="APIs">
|
||||
<CardWrapper>
|
||||
<Card
|
||||
link="/docs/examples/secure-api/go"
|
||||
imageSource="/docs/img/tech/golang.svg"
|
||||
title="GO"
|
||||
description="This example shows you how to secure an API written in GO."
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/secure-api/python-flask"
|
||||
imageSource="/docs/img/tech/python.svg"
|
||||
title="Python"
|
||||
description="This example shows you how to secure a Python3 Flask API."
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/secure-api/dot-net"
|
||||
imageSource="/docs/img/tech/dotnet.svg"
|
||||
title=".NET"
|
||||
description="This example shows you how to secure a .NET API."
|
||||
/>
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
<TabItem value="zitadel" label="ZITADEL · APIs">
|
||||
<CardWrapper>
|
||||
<Card
|
||||
link="/docs/examples/call-zitadel-api/go"
|
||||
imageSource="/docs/img/tech/golang.svg"
|
||||
title="GO"
|
||||
description="Demonstrates how to fetch some data from the ZITADEL management API."
|
||||
/>
|
||||
<Card
|
||||
link="/docs/examples/call-zitadel-api/dot-net"
|
||||
imageSource="/docs/img/tech/dotnet.svg"
|
||||
title=".NET"
|
||||
description="This integration guide shows you how to integrate ZITADEL into your .NET application. It demonstrates how to fetch some data from the ZITADEL management API."
|
||||
/>
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
<TabItem value="proxy" label="Proxy">
|
||||
<CardWrapper>
|
||||
<Card
|
||||
link="/docs/examples/identity-proxy/oauth2-proxy"
|
||||
imageSource="/docs/img/tech/oauth2-proxy.svg"
|
||||
title="OAuth 2.0 Proxy"
|
||||
description="Allows services to delegate the authentication flow to a IDP, for example ZITADEL"
|
||||
/>
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Clone a sample project
|
||||
|
||||
<CardWrapper>
|
||||
<Card
|
||||
githubLink="https://github.com/zitadel/zitadel-java"
|
||||
title="Java"
|
||||
label="Java"
|
||||
/>
|
||||
<Card
|
||||
githubLink="https://github.com/zitadel/zitadel-python3"
|
||||
title="Python"
|
||||
label="Python"
|
||||
/>
|
||||
<Card
|
||||
githubLink="https://github.com/zitadel/zitadel-angular"
|
||||
title="Angular"
|
||||
label="Web · Mobile Web"
|
||||
/>
|
||||
<Card
|
||||
githubLink="https://github.com/zitadel/zitadel-nextjs"
|
||||
title="NextJS"
|
||||
label="Web · Mobile Web"
|
||||
/>
|
||||
<Card
|
||||
githubLink="https://github.com/zitadel/zitadel_flutter"
|
||||
title="Flutter"
|
||||
label="Android · iOS · Web · Mobile Web"
|
||||
/>
|
||||
</CardWrapper>
|
||||
|
||||
## 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) |
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Overview
|
||||
title: Deploy ZITADEL
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
Choose your platform and run ZITADEL with the most minimal configuration possible.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user