mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
96f9bbc044
### **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]>
Zitadel Console
The Console is Zitadels management UI.
It is built using Angular and part of the Zitadel monorepo.
To get started follow the contributing quick start.
Building
To build for production:
pnpm nx run @zitadel/console:build
This will:
- Generate proto files (via
prebuildscript) - Build the Angular app with production optimizations
Linting
To run linting and formatting checks:
pnpm nx @zitadel/console:lint
To auto-fix formatting issues:
pnpm nx @zitadel/console:lint-fix
Project Structure
src/app/proto/generated/- Generated proto files (Angular-specific format)buf.gen.yaml- Local proto generation configurationproject.json- Nx orchestration and caching for builds and testsprebuild.development.js- Development environment configuration script
Dependency Chain
The Console app has the following build dependencies managed by Nx:
@zitadel/proto:generate- Generates the protobuf stubs@zitadel/client:build- Builds the TypeScript gRPC client library@zitadel/console:generate- Generates Console-specific protobuf stubs@zitadel/console:build- Creates a production build from Console
This ensures that the Console always has access to the latest client library and protobuf definitions.
Proto Generation Details
@zitadel/protogeneration: Modern ES modules with@bufbuild/protobuffor v2 APIs- Local
buf.gen.yamlgeneration: Traditional protobuf JavaScript classes for v1 APIs
The Console app calls Zitadel v1 and v2 APIs. As long as the Console still calls v1 APIs, it needs to import client stubs from separate sources:
Legacy v1 API (Traditional Protobuf)
- Uses local
buf.gen.yamlconfiguration - Generates traditional Google protobuf JavaScript classes extending
jspb.Message - Uses plugins:
protocolbuffers/js,grpc/web,grpc-ecosystem/openapiv2 - Output:
src/app/proto/generated/ - Used for: Most existing Console functionality
Modern v2 API (ES Modules)
- Uses
@zitadel/protopackage generation - Generates modern ES modules with
@bufbuild/protobuf - Uses plugin:
@bufbuild/eswith ES modules and JSON types - Output:
login/packages/zitadel-proto/ - Used for: New user v2 API and services
Dependency Management
The Console's project.json ensures proper execution order:
@zitadel/proto:generateruns first (modern ES modules)- Console's local generation runs second (traditional protobuf)
- Build/lint/start tasks depend on both generations being complete
This approach allows the Console app to use both v1 and v2 APIs while maintaining proper build dependencies.
Legacy Information
This project was originally generated with Angular CLI version 8.3.20 and has been updated over time.