mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 23:57:31 +00:00
docs: proposal restructure (#5318)
* docs: docs structure * docs: remove sdk from main nav * docs: fix broken links * docs: texts * docs: texts * docs: react example * docs: proposal restructure * remove manual, move troubleshooting * revmove duplicate item * identity providers * broken links and rel paths * examples wip * examples * navigation * support * solution scenarios * concepts * overview * Actions caution to info * suggestions from code review * remove start command again * proposed start command (with and without api) * wip startpage * startpage * broken link integrate * remove get started from nav * Apply suggestions from code review Co-authored-by: Elio Bischof <elio@zitadel.com> --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Florian Forster <florian@zitadel.com> Co-authored-by: Elio Bischof <elio@zitadel.com>
This commit is contained in:
mffap
@@ -142,7 +142,15 @@ export function ListElement({
|
||||
description,
|
||||
}) {
|
||||
return (
|
||||
<a className={styles.listelement} href={link}>
|
||||
<a
|
||||
className={styles.listelement}
|
||||
href={link}
|
||||
onClick={() => {
|
||||
window.plausible("ListElement", {
|
||||
props: { method: title },
|
||||
});
|
||||
}}
|
||||
>
|
||||
{type
|
||||
? type
|
||||
: iconClasses && (
|
||||
|
||||
@@ -17,14 +17,13 @@ import styles from "./styles.module.css";
|
||||
|
||||
const features = [
|
||||
{
|
||||
title: "Guides",
|
||||
title: "Documentation", // TODO: Plausible
|
||||
darkImageUrl: "img/index/Guides-dark.svg",
|
||||
lightImageUrl: "img/index/Guides-light.svg",
|
||||
link: "guides/overview",
|
||||
description: (
|
||||
<>
|
||||
Read our guides on how to manage your data and role associations in
|
||||
ZITADEL and on what we recommend.
|
||||
Read our documentation and learn how you can setup, customize, and integrate authentication and authorization to your project.
|
||||
</>
|
||||
),
|
||||
content: (
|
||||
@@ -37,27 +36,35 @@ const features = [
|
||||
title="Get started"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/manage/cloud/overview"
|
||||
type={ICONTYPE.LOGIN}
|
||||
title="ZITADEL Cloud"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/integrate/login-users"
|
||||
type={ICONTYPE.LOGIN}
|
||||
title="Login Users"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/integrate/access-zitadel-apis"
|
||||
<ListElement
|
||||
link="/docs/examples/sdks"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Access APIs"
|
||||
title="SDKs"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/examples/introduction"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Example Apps"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/manage/console/overview"
|
||||
type={ICONTYPE.LOGIN}
|
||||
title="Manage"
|
||||
description="All about Console"
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/integrate"
|
||||
type={ICONTYPE.LOGIN}
|
||||
title="Integrate"
|
||||
description="Access our APIs and configure services and tools"
|
||||
/>
|
||||
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<ListElement
|
||||
<ListElement
|
||||
link="/docs/guides/solution-scenarios/introduction"
|
||||
iconClasses="las la-paragraph"
|
||||
roundClasses="custom-rounded custom-rounded-split"
|
||||
@@ -65,6 +72,18 @@ const features = [
|
||||
title="Solution Scenarios"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/concepts/introduction"
|
||||
type={ICONTYPE.TASKS}
|
||||
title="Concepts"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/concepts/architecture/software"
|
||||
type={ICONTYPE.ARCHITECTURE}
|
||||
title="Architecture"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/manage/customize/branding"
|
||||
type={ICONTYPE.PRIVATELABELING}
|
||||
@@ -72,15 +91,9 @@ const features = [
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/self-hosting/deploy/overview"
|
||||
type={ICONTYPE.SYSTEM}
|
||||
title="Deploy"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/guides/trainings/introduction"
|
||||
type={ICONTYPE.STORAGE}
|
||||
title="Trainings"
|
||||
link="/docs/support/troubleshooting"
|
||||
type={ICONTYPE.HELP}
|
||||
title="Support"
|
||||
description=""
|
||||
/>
|
||||
</div>
|
||||
@@ -89,43 +102,42 @@ const features = [
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Quickstarts",
|
||||
title: "Get Started",
|
||||
darkImageUrl: "/docs/img/index/Quickstarts-dark.svg",
|
||||
lightImageUrl: "img/index/Quickstarts-light.svg",
|
||||
link: "examples/introduction",
|
||||
description: (
|
||||
<>
|
||||
Learn how to integrate your applications and build secure workflows and
|
||||
APIs with ZITADEL
|
||||
</>
|
||||
<>Learn how to integrate your applications and build secure workflows and
|
||||
APIs with ZITADEL.</>
|
||||
),
|
||||
content: (
|
||||
<div className={styles.quickstartcontainer}>
|
||||
<QuickstartLink
|
||||
link="/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"
|
||||
/>
|
||||
<QuickstartLink
|
||||
link="/examples/login/react"
|
||||
imageSource="/docs/img/tech/react.png"
|
||||
title="React"
|
||||
description="Logs into your application and queries some data from the userinfo endpoint"
|
||||
/>
|
||||
<QuickstartLink
|
||||
link="/examples/login/flutter"
|
||||
imageSource="/docs/img/tech/flutter.svg"
|
||||
title="Flutter"
|
||||
description="Mobile Application working for iOS and Android that authenticates your user."
|
||||
/>
|
||||
<QuickstartLink
|
||||
link="/examples/login/nextjs"
|
||||
imageSource="/docs/img/tech/nextjslight.svg"
|
||||
lightImageSource="/docs/img/tech/nextjs.svg"
|
||||
title="NextJS"
|
||||
description="A simple application to log into your user account and query some data from User endpoint."
|
||||
/>
|
||||
<div className={styles.apilinks}>
|
||||
<ListWrapper>
|
||||
<ListElement
|
||||
link=""
|
||||
type={ICONTYPE.START}
|
||||
title="Quick Start Guide"
|
||||
description="The ultimate guide to get started with ZITADEL."
|
||||
/>
|
||||
<ListElement
|
||||
link=""
|
||||
type={ICONTYPE.APIS}
|
||||
title="Frontend Quickstart Guides"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link=""
|
||||
type={ICONTYPE.APIS}
|
||||
title="Backend Quickstart Guides"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/examples/introduction"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Examples"
|
||||
description="Clone an existing example application."
|
||||
/>
|
||||
</ListWrapper>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
@@ -141,51 +153,82 @@ const features = [
|
||||
<div className={styles.apilinks}>
|
||||
<ListWrapper>
|
||||
<ListElement
|
||||
link="/docs/apis/proto/auth"
|
||||
link="/docs/apis/auth/authentication-api-aka-auth"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Proto Definitions"
|
||||
description=""
|
||||
title="Authenticated User"
|
||||
description="All operations on the currently authenticated user."
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/apis/mgmt/management-api"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Organization Objects"
|
||||
description="Mutate IAM objects like organizations, projects, clients, users etc."
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/apis/admin/administration-api-aka-admin"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Instance Objects"
|
||||
description="Configure and manage the IAM instance."
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/apis/openidoauth/endpoints"
|
||||
type={ICONTYPE.APIS}
|
||||
title="OpenID Connect and OAuth"
|
||||
description="Scopes, Claims, Authentication Methods, Grant Types"
|
||||
/>
|
||||
title="OIDC Endpoints"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/apis/saml/endpoints"
|
||||
type={ICONTYPE.APIS}
|
||||
title="SAML Endpoints"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/apis/actions/introduction"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Actions"
|
||||
description="Customize and integrate ZITADEL into your landscape"
|
||||
/>
|
||||
|
||||
</ListWrapper>
|
||||
|
||||
</div>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Concepts",
|
||||
title: "Self-hosting",
|
||||
darkImageUrl: "img/index/Concepts-dark.svg",
|
||||
lightImageUrl: "img/index/Concepts-light.svg",
|
||||
link: "concepts/introduction",
|
||||
link: "/docs/self-hosting/deploy/overview",
|
||||
description: (
|
||||
<>
|
||||
Learn more about engineering and design principles, ZITADELs
|
||||
architecture and used technologies.
|
||||
Everything you need to know about self-hosting ZITADEL.
|
||||
</>
|
||||
),
|
||||
content: (
|
||||
<ListWrapper>
|
||||
<ListElement
|
||||
link="/docs/concepts/principles"
|
||||
link="/docs/self-hosting/deploy/overview"
|
||||
type={ICONTYPE.SYSTEM}
|
||||
title="Deploy"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/self-hosting/manage/production"
|
||||
type={ICONTYPE.TASKS}
|
||||
title="Principles"
|
||||
description="Design and engineering principles"
|
||||
title="Production Setup"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/concepts/architecture/software"
|
||||
type={ICONTYPE.ARCHITECTURE}
|
||||
title="Architecture"
|
||||
description="Sotware-, Cluster- and Multi Cluster Architecture"
|
||||
link="/docs/self-hosting/manage/configure"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Configuration"
|
||||
description=""
|
||||
/>
|
||||
<ListElement
|
||||
link="/docs/concepts/structure/overview"
|
||||
type={ICONTYPE.ARCHITECTURE}
|
||||
title="Structure"
|
||||
description="Object structure of ZITADEL"
|
||||
link="/docs/self-hosting/manage/updating_scaling"
|
||||
type={ICONTYPE.APIS}
|
||||
title="Update and Scaling"
|
||||
description=""
|
||||
/>
|
||||
</ListWrapper>
|
||||
),
|
||||
|
||||
Reference in New Issue
Block a user