mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
### **Restructure Docs Navigation & Consolidate Core Concepts**
**Summary**
This PR refactors the documentation navigation to follow a clearer
**User Journey** and consolidates fragmented pages to reduce redundancy.
**Key Changes**
* **Sidebar:**
* Replaced the legacy resource-based structure with user-journey-focused
categories.
**Proposed Structure:**
```
Get Started
├─ Overview
│ └─ Guides Overview (Brief intro to docs, persona-aligned: "Get auth working in minutes for your B2B app.")
├─ Quickstart Guide
│ └─ Quickstart (Step-by-step: Sign up, spin up instance, connect app, log in – mirrors brand's 4-step guide.)
├─ Authenticate Users
│ ├─ Login with ZITADEL (OIDC)
│ ├─ Get ID / Access Token
│ └─ Logout
├─ Examples & SDKs
│ ├─ SPA / Frontend
│ ├─ Web Applications
│ ├─ APIs / Backend Services
│ ├─ Hybrid / Full-Stack
│ └─ Sample Applications (Include community-contributed examples for openness.)
├─ Key Concepts
│ ├─ Instances, Orgs, Projects, Apps
│ ├─ Policies (Intro)
│ └─ Users & Roles
└─ Use Cases
├─ B2B Integration (Tailored to multi-tenant enterprise needs.)
├─ B2C Login
├─ Multi-Tenant / SaaS
├─ Branded Login & White-Label
└─ Machine-to-Machine (M2M)
Configure Identity & Policies
├─ Identity Providers
│ ├─ External IDPs (e.g., Google, Azure)
│ └─ Custom Providers
├─ Policies
│ ├─ Password Policies
│ ├─ Lockout Policies
│ └─ Privacy Policies
├─ Roles & Permissions
│ ├─ RBAC Setup
│ └─ Custom Roles
└─ Compliance & Security
├─ Audits & Logs
└─ Certifications (Highlight trust through openness.)
Integrate & Authenticate
├─ OIDC & OAuth Flows
├─ API Access
│ ├─ gRPC APIs
│ └─ REST APIs
├─ SDKs
│ ├─ Go
│ ├─ JavaScript/TypeScript
│ ├─ Python
│ └─ Others (Link to community SDKs.)
└─ External Integrations
├─ SAML
├─ LDAP
└─ Webhooks
Test & Debug
├─ Testing Tools
│ ├─ Console Testing
│ └─ API Playground
├─ Common Issues
│ ├─ Token Errors
│ └─ Integration Failures
└─ Debugging Guides
├─ Logs & Monitoring
└─ Error Codes Reference
Deploy & Operate
├─ Deployment Options
│ ├─ Cloud (ZITADEL Cloud)
│ ├─ Self-Hosted (Linux, MacOS)
│ ├─ Docker Compose
│ └─ Kubernetes
├─ Configuration
│ ├─ Environment Variables
│ └─ Advanced Settings
├─ Scaling & Performance
│ ├─ High Availability
│ └─ Backup & Restore
└─ Monitoring & Maintenance
├─ Metrics
└─ Upgrades
Architecture & Concepts
├─ System Architecture
│ ├─ Core Components
│ └─ Data Flow Diagrams (Expressive visuals per brand.)
├─ Principles
│ ├─ Multi-Tenancy
│ └─ Open Standards (OIDC, SAML)
└─ Advanced Topics
├─ Customization
└─ Extensibility (Open-source contributions.)
Product, Releases & Support
├─ Product Features
│ ├─ Roadmap (Public, for transparency.)
│ └─ Pricing & Tiers
├─ Releases
│ ├─ Changelog
│ └─ Upgrade Guides
└─ Support Resources
├─ Community (Discord, GitHub – for community-led growth.)
├─ FAQ
├─ Contact Support
└─ Contribute (Encourage feedback/shaping the product.)
```
**Content Consolidation:**
* Merged separate "Concept" and "Console Guide" files into single,
comprehensive **Overview** pages for core resources:
* `Organizations`, `Projects`, `Applications`, `Users`, `Console`, and
`Actions`.
```
concepts/structure/organizations + guides/manage/console/organizations -> guides/manage/console/organizations-overview
concepts/structure/projects + guides/manage/console/projects -> guides/manage/console/projects-overview
concepts/structure/applications + guides/manage/console/applications -> guides/manage/console/applications-overview
concepts/structure/users + guides/manage/console/users -> guides/manage/console/users-overview
guides/manage/console/actions + apis/actions/introduction -> guides/manage/console/actions-overview
concepts/features/console + guides/manage/console/overview -> guides/manage/console/console-overview
```
**Redirects (`vercel.json`):**
* Added permanent redirects for all the 6 legacy files mentioned above
**No files were deleted**
---------
Co-authored-by: Florian Forster <[email protected]>
298 lines
9.9 KiB
JSON
298 lines
9.9 KiB
JSON
{
|
|
"$schema": "https://openapi.vercel.sh/vercel.json",
|
|
"buildCommand": "pnpm nx run @zitadel/docs:build",
|
|
"github": {
|
|
"enabled": true
|
|
},
|
|
"cleanUrls": true,
|
|
"rewrites": [
|
|
{
|
|
"source": "/docs/proxy/js/script.js",
|
|
"destination": "https://plausible.io/js/script.tagged-events.pageview-props.outbound-links.js"
|
|
},
|
|
{
|
|
"source": "/docs/proxy/api/event",
|
|
"destination": "https://plausible.io/api/event"
|
|
},
|
|
{
|
|
"source": "/docs/:match*",
|
|
"destination": "/:match*"
|
|
}
|
|
],
|
|
"redirects": [
|
|
{
|
|
"source": "/",
|
|
"destination": "/docs"
|
|
},
|
|
{
|
|
"source": "/docs/category/apis/:slug*",
|
|
"destination": "/docs/apis/:slug*",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/mgmt/:slug*",
|
|
"destination": "/docs/apis/resources/mgmt/:slug*",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/auth/:slug*",
|
|
"destination": "/docs/apis/resources/auth/:slug*",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/system/:slug*",
|
|
"destination": "/docs/apis/resources/system/:slug*",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/admin/:slug*",
|
|
"destination": "/docs/apis/resources/admin/:slug*",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/actionsv2/introduction",
|
|
"destination": "/docs/apis/actions/v2/usage",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/actionsv2/execution-local",
|
|
"destination": "/docs/apis/actions/v2/testing-locally",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/human-users",
|
|
"destination": "/docs/guides/integrate/login",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/solution-scenarios/device-authorization",
|
|
"destination": "/docs/guides/integrate/login/oidc/device-authorization",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/oauth-recommended-flows",
|
|
"destination": "/docs/guides/integrate/login/oidc/oauth-recommended-flows",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login-users",
|
|
"destination": "/docs/guides/integrate/login/oidc/login-users",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/logout",
|
|
"destination": "/docs/guides/integrate/login/oidc/logout",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/solution-scenarios/onboarding",
|
|
"destination": "/docs/guides/integrate/onboarding",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/solution-scenarios/onboarding/b2b",
|
|
"destination": "/docs/guides/integrate/onboarding/b2b",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/solution-scenarios/onboarding/end-users",
|
|
"destination": "/docs/guides/integrate/onboarding/end-users",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/concepts/structure/jwt_idp",
|
|
"destination": "/docs/guides/integrate/identity-providers/jwt-idp",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/solution-scenarios/onboarding/end-users",
|
|
"destination": "/docs/guides/integrate/onboarding/end-users",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/serviceusers",
|
|
"destination": "/docs/guides/integrate/service-users/authenticate-service-users",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/private-key-jwt",
|
|
"destination": "/docs/guides/integrate/service-users/private-key-jwt",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/client-credentials",
|
|
"destination": "/docs/guides/integrate/service-users/client-credentials",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/pat",
|
|
"destination": "/docs/guides/integrate/service-users/private-access-token",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/access-zitadel-apis",
|
|
"destination": "/docs/guides/integrate/zitadel-apis/access-zitadel-apis",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/access-zitadel-system-api",
|
|
"destination": "/docs/guides/integrate/zitadel-apis/access-zitadel-system-api",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/event-api",
|
|
"destination": "/docs/guides/integrate/zitadel-apis/event-api",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/examples/call-zitadel-api/go",
|
|
"destination": "/docs/guides/integrate/zitadel-apis/example-zitadel-api-with-go",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/examples/call-zitadel-api/dot-net",
|
|
"destination": "/docs/guides/integrate/zitadel-apis/example-zitadel-api-with-dot-net",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/terraform/basics",
|
|
"destination": "/docs/guides/manage/terraform-provider",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/identity-providers",
|
|
"destination": "/docs/guides/integrate/identity-providers/introduction",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#centralized-authentication-endpoint",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#centralized-authentication-endpoint",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#security-and-compliance",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#security-and-compliance",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#developer-friendly-integration",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#developer-friendly-integration",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#key-features-of-the-hosted-login",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#key-features-of-the-hosted-login",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#flexible-usernames",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#flexible-usernames",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#support-for-multiple-authentication-methods",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#support-for-multiple-authentication-methods",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#enterprise-single-sign-on",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#enterprise-single-sign-on",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#multi-tenancy-authentication",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#multi-tenancy-authentication",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#customization-options",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#customization-options",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#fast-account-switching",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#fast-account-switching",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#self-service-for-users",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#self-service-for-users",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login/login-users#password-reset",
|
|
"destination": "/docs/guides/integrate/login/hosted-login#password-reset",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/integrate/login-ui/typescript-repo",
|
|
"destination": "/docs/guides/integrate/login-ui/login-app",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/legal/service-description/billing",
|
|
"destination": "https://help.zitadel.com/pricing-and-billing-of-zitadel-services",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/console/overview",
|
|
"destination": "/docs/guides/manage/console/console-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/console/organizations",
|
|
"destination": "/docs/guides/manage/console/organizations-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/concepts/structure/organizations",
|
|
"destination": "/docs/guides/manage/console/organizations-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/console/projects",
|
|
"destination": "/docs/guides/manage/console/projects-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/concepts/structure/projects",
|
|
"destination": "/docs/guides/manage/console/projects-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/console/applications",
|
|
"destination": "/docs/guides/manage/console/applications-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/concepts/structure/applications",
|
|
"destination": "/docs/guides/manage/console/applications-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/console/users",
|
|
"destination": "/docs/guides/manage/console/users-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/concepts/structure/users",
|
|
"destination": "/docs/guides/manage/console/users-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/guides/manage/console/actions",
|
|
"destination": "/docs/guides/manage/console/actions-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/apis/actions/introduction",
|
|
"destination": "/docs/guides/manage/console/actions-overview",
|
|
"permanent": true
|
|
},
|
|
{
|
|
"source": "/docs/concepts/features/console",
|
|
"destination": "/docs/guides/manage/console/console-overview",
|
|
"permanent": true
|
|
}
|
|
]
|
|
} |