d7cec1d3bd
chore: replace "manager role" with "administrator role" ( #11395 )
...
# Which Problems Are Solved
As part of the naming consistency initiative, the term `Manager Roles`
is replaced by `Administrator Roles`
# How the Problems Are Solved
By replacing `Manager Roles` with `Administrator Roles` in API docs,
Console UI, and guides.
# Additional Changes
N/A
# Additional Context
- Closes https://github.com/zitadel/zitadel/issues/11293
---------
Co-authored-by: Copilot <[email protected]
2026-01-21 13:06:27 +05:30
Livio Spring and GitHub
8c0d6c6817
chore: naming custom domain ( #11383 )
...
# Which Problems Are Solved
As part of the consistent naming effort, this PR focuses on "Custom
Domains".
# How the Problems Are Solved
- All terms referring to a domain identifying an instance were changed
to "Custom Domain" or "custom domain".
- All placeholders were changed to `${CUSTOM_DOMAIN}` or
`$CUSTOM_DOMAIN` (if escaping was not possible)
- Some other placeholders were change to the same style.
- One occurrence of custom domain was changed to organization domain to
prevent misunderstandings.
# Additional Changes
None
# Additional Context
- closes #11296
- customer portal is fixed on
https://github.com/zitadel/website/pull/1570
- angular example is updated on
https://github.com/zitadel/zitadel-angular/pull/29
2026-01-20 10:26:57 +05:30
96f9bbc044
docs: structure update ( #11275 )
...
### **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]
2026-01-09 15:07:02 -03:00
4101e1cd49
chore(docs): Migrate from Docusaurus v2 to v3 ( #8036 )
...
Migrate Docs to latest version of Docusaursu (3.3.2 as of time of
writing)
---------
Co-authored-by: Florian Forster <[email protected]
2024-06-20 12:55:03 +00:00
599a1ddd78
docs:change titles ( #6582 )
...
* Modified quick start guide to reflect the new onboarding changes.
* Modified titles to optimize indexing. Left thet titles in title case for now.
* Added side bar labels and also made minor changes to titles.
* Update docs/docs/apis/openidoauth/endpoints.mdx
Co-authored-by: Fabi <[email protected] [email protected]
2023-09-19 13:50:00 +02:00
Max Peintner and GitHub
2068384a0e
docs(nextjs): yarn, remove redundant description ( #5764 )
...
* docs: yarn, remove redundant description
* remove pkce
* rm pkce from b2b demo
2023-07-07 07:05:36 +00:00
8d4d182c20
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 <[email protected] [email protected] [email protected] [email protected]
2023-03-07 09:33:13 +02:00
Miguel Cabrerizo and GitHub
60e3e30bca
fix: typo Urls should be URLs ( #5327 )
...
change Urls to URLs in i18n files
2023-03-02 15:30:11 +00:00
Florian Forster and GitHub
065250a108
chore(docs): fix links for domain migration ( #4831 )
...
* chore(docs): fix links for domain migration
* try trailing slash for netlify
* trial
* fix typo
* test path
* try preview proxied
* test local proxy
* try to define the domain with redirect to /docs
* remove build commands
* debug netlify router and fix image link
* working config
* fix analytics
2022-12-06 20:33:13 +01:00
9fbd1034c2
docs(NextJS): use auth method basic for guides ( #4802 )
...
* docs: nextjs using code with auth method basic
* Update docs/docs/examples/login/nextjs-b2b.md
Co-authored-by: Florian Forster <[email protected] [email protected]
2022-12-01 11:25:17 +01:00
Max Peintner and GitHub
1b868b6a7f
docs: nextjs b2b example, plausible outbound links script ( #4738 )
...
* b2b example, link from b2b solution scenario, cleanup nextjs doc
* b2b md
* repo link
* add plausible outbound events
* update examples link
2022-11-23 13:27:09 +00:00
Livio SpringandGitHub
Max PeintnerandGitHub
Miguel CabrerizoandGitHub