mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-20 03:48:47 +00:00
docs: Improve README for local development and standardize tab usage (#11865)
## Problem statement - `<Tabs>` were not rendered in docs - Missing steps in README for local dev ## How it was solved - Enhance the README to better describe local development setup and clean up formatting. - Standardize the use of tabs across various components for consistency. ## Additional info To not cause merge conflicts with https://github.com/zitadel/zitadel/pull/11729 changes in `/self-hosting/manage/configure/configure.mdx` were skipped
This commit is contained in:
@@ -132,7 +132,7 @@ You will need to implement a listener that can receive HTTP requests.
|
||||
For this example, we will use a simple Go HTTP server that will print the received request to standard output.
|
||||
As mentioned before, this validation can and should be applied to any target implementation.
|
||||
|
||||
<Tabs>
|
||||
<Tabs defaultIndex={0} items={['JSON', 'JWT', 'JWE']}>
|
||||
<Tab value="JSON">
|
||||
<DynamicCodeBlock lang="go" code={JsonGo} />
|
||||
</Tab>
|
||||
|
||||
@@ -168,8 +168,12 @@ You can also activate the v2 login for your apps, so users are redirected to `/u
|
||||
|
||||
**Customizing the new login:** The easiest way to actually customizing it is to fork the https://github.com/zitadel/zitadel repo and use the [Deploy with Vercel button](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#login-deploy) to run your login code on Vercel.
|
||||
|
||||
<Tabs queryString="deployment">
|
||||
<Tab value="zitadel_cloud" label="Activate Zitadel Cloud V2 Login" default="true">
|
||||
<Tabs
|
||||
groupId="deployment"
|
||||
defaultIndex={0}
|
||||
items={['Activate Zitadel Cloud V2 Login', 'Vercel Custom Login Deployment']}
|
||||
>
|
||||
<Tab value="Activate Zitadel Cloud V2 Login">
|
||||
|
||||
Zitadel Cloud provides the V2 login at the fixed path `/ui/v2/login`.
|
||||
<PreventLockout components={props.components} />
|
||||
@@ -181,7 +185,7 @@ You can also activate the v2 login for your apps, so users are redirected to `/u
|
||||
2. Enable the [loginV2 feature](/reference/api/feature/zitadel.feature.v2.FeatureService.SetInstanceFeatures) on the instance. Leave the base URI empty to use the default. If you enable this feature, the login will be used for every application configured in your Zitadel instance. (Example: https://your-zitadel-instance.zitadel.cloud/ui/v2/login)
|
||||
|
||||
</Tab>
|
||||
<Tab value="vercel_custom" label="Vercel Custom Login Deployment">
|
||||
<Tab value="Vercel Custom Login Deployment">
|
||||
|
||||
The simplest way to deploy the new login for yourself is by using the [Deploy with Vercel button](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#login-deploy) to deploy the login directly to your Vercel.
|
||||
|
||||
|
||||
@@ -10,20 +10,16 @@ export default function AuthMethods(props) {
|
||||
<div>
|
||||
<Tabs
|
||||
groupId="auth-type"
|
||||
default="pkce"
|
||||
values={[
|
||||
{ label: "PKCE", value: "pkce" },
|
||||
{ label: "Basic Auth", value: "basic" },
|
||||
{ label: "JWT with Private Key", value: "jwtpk" },
|
||||
]}
|
||||
defaultIndex={0}
|
||||
items={["PKCE","Basic Auth","JWT with Private Key"]}
|
||||
>
|
||||
<Tab value="pkce">
|
||||
<Tab value="PKCE">
|
||||
<PKCE components={props.components} />
|
||||
</Tab>
|
||||
<Tab value="basic">
|
||||
<Tab value="Basic Auth">
|
||||
<Basic components={props.components} />
|
||||
</Tab>
|
||||
<Tab value="jwtpk">
|
||||
<Tab value="JWT with Private Key">
|
||||
<JWTPrivateKey components={props.components} />
|
||||
</Tab>
|
||||
</Tabs>
|
||||
@@ -31,26 +27,23 @@ export default function AuthMethods(props) {
|
||||
) : props.selected == "native" ? (
|
||||
<Tabs
|
||||
groupId="auth-type"
|
||||
default="pkce"
|
||||
values={[{ label: "PKCE", value: "pkce" }]}
|
||||
defaultIndex={0}
|
||||
items={["PKCE"]}
|
||||
>
|
||||
<Tab value="pkce">
|
||||
<Tab value="PKCE">
|
||||
<PKCE components={props.components} Native />
|
||||
</Tab>
|
||||
</Tabs>
|
||||
) : props.selected == "spa" ? (
|
||||
<Tabs
|
||||
groupId="auth-type"
|
||||
default="pkce"
|
||||
values={[
|
||||
{ label: "PKCE", value: "pkce" },
|
||||
{ label: "Implicit", value: "implicit" },
|
||||
]}
|
||||
defaultIndex={0}
|
||||
items={["PKCE","Implicit"]}
|
||||
>
|
||||
<Tab value="pkce">
|
||||
<Tab value="PKCE">
|
||||
<PKCE components={props.components} />
|
||||
</Tab>
|
||||
<Tab value="implicit">
|
||||
<Tab value="Implicit">
|
||||
<Implicit components={props.components} />
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
@@ -53,14 +53,10 @@ This will start a wizard asking you for an application name and a type.
|
||||
|
||||
<Tabs
|
||||
groupId="app-type"
|
||||
default="web"
|
||||
values={[
|
||||
{'label': 'Web Application', 'value': 'web'},
|
||||
{'label': 'Native Application', 'value': 'native'},
|
||||
{'label': 'Single Page Application', 'value': 'spa'},
|
||||
]}
|
||||
defaultIndex={0}
|
||||
items={['Web Application','Native Application','Single Page Application']}
|
||||
>
|
||||
<Tab value="web">
|
||||
<Tab value="Web Application">
|
||||
|
||||
#### Authentication method
|
||||
|
||||
@@ -73,7 +69,7 @@ Please change the authentication method here as well, if you did so in the wizar
|
||||
<AuthMethods components={props.components} selected="web" />
|
||||
</Tab>
|
||||
|
||||
<Tab value="native">
|
||||
<Tab value="Native Application">
|
||||
|
||||
#### Authentication method
|
||||
|
||||
@@ -82,7 +78,7 @@ When selecting Native the authentication method always needs to be PKCE.
|
||||
<AuthMethods components={props.components} selected="native" />
|
||||
</Tab>
|
||||
|
||||
<Tab value="spa">
|
||||
<Tab value="Single Page Application">
|
||||
|
||||
#### Authentication method
|
||||
|
||||
|
||||
Reference in New Issue
Block a user