docs: add description frontmatter to content pages for SEO (#11654)

2026-11-03 04:42:15 +00:00 · 2026-02-21 07:44:42 -08:00
parent afeeee87c3
commit 2c260a1f10
304 changed files with 421 additions and 46 deletions
@@ -1,5 +1,6 @@
 ---
 title: Set up Zitadel with Docker Compose
+description: "Deploy a ZITADEL instance locally using Docker Compose for rapid testing and development."
 sidebar_label: Docker Compose
 ---

@@ -1,5 +1,6 @@
 ---
 title: Developing ZITADEL with Dev Containers
+description: "Set up a local ZITADEL development environment using dev containers with Docker and VS Code for minimal setup"
 sidebar_label: Dev Containers
 ---

@@ -1,5 +1,6 @@
 ---
 title: Caching
+description: "Configure ZITADEL caching with Redis or Valkey on Kubernetes using authentication methods like passwords and TLS connections"
 sidebar_label: Caching
 ---

@@ -1,5 +1,6 @@
 ---
 title: Configuration
+description: "Configure ZITADEL Helm chart settings for Kubernetes deployments including global, ZITADEL, and scaling options"
 sidebar_label: Configuration
 ---

@@ -1,5 +1,6 @@
 ---
 title: Database
+description: "Configure PostgreSQL connections for ZITADEL on Kubernetes with TLS options to secure database traffic during deployment"
 sidebar_label: Database
 ---

@@ -1,6 +1,7 @@
 ---
 title: Kubernetes
 sidebar_label: Overview
+description: Deploy ZITADEL on Kubernetes using Helm charts for scalable identity management
 ---


@@ -1,5 +1,6 @@
 ---
 title: Ingress
+description: "Configure Kubernetes Ingress resources for ZITADEL and Login containers to manage API traffic and UI access"
 sidebar_label: Ingress
 ---

@@ -1,5 +1,6 @@
 ---
 title: Installation
+description: "Deploy ZITADEL on Kubernetes using Helm with a PostgreSQL database and an Ingress controller for external access"
 sidebar_label: Installation
 ---

@@ -1,5 +1,6 @@
 ---
 title: Observability
+description: "Collect traces, metrics, and logs from ZITADEL and Login containers using OpenTelemetry and Prometheus for observability monitoring"
 sidebar_label: Observability
 ---

@@ -1,5 +1,6 @@
 ---
 title: Operations
+description: "Manage and scale ZITADEL on Kubernetes, covering upgrades, manual and automated scaling, and database considerations"
 sidebar_label: Operations
 ---

@@ -1,5 +1,6 @@
 ---
 title: Uninstalling
+description: "Uninstall ZITADEL from a Kubernetes cluster by removing the Helm release and cleaning up residual resources"
 sidebar_label: Uninstalling
 ---

@@ -1,5 +1,6 @@
 ---
 title: Install Zitadel on Linux
+description: "Installing ZITADEL and PostgreSQL on Linux for a self-hosted environment."
 sidebar_label: Linux
 ---

@@ -1,5 +1,6 @@
 ---
 title: Install ZITADEL on MacOS
+description: "Install PostgreSQL, then deploy ZITADEL on MacOS using Homebrew or by downloading from GitHub and running the binary"
 sidebar_label: MacOS
 ---

@@ -1,5 +1,6 @@
 ---
 title: Deploy ZITADEL
+description: "Comprehensive deployment options for ZITADEL on Linux, macOS, Docker Compose, and Kubernetes."
 sidebar_label: Overview
 ---

@@ -23,7 +24,7 @@ The easiest way to use ZITADEL is to run one of our container releases
 - **stable** is the current **production** release of ZITADEL.
 - **latest** is the **last created** release from our pipelines that gets updated in a high frequency.

-# Production Setup
+## Production Setup

 After you have successfully created your first test environment using one of the deployment guides in this section,
 you might want to configure ZITADEL for production and embed it into your system landscape.
@@ -1,5 +1,6 @@
 ---
 title: Troubleshoot ZITADEL
+description: "Resolve common ZITADEL self-hosting issues, including instance not found and upstream header errors during deployment troubleshooting"
 ---

 import InstanceNotFound from "../../../self-hosting/deploy/troubleshooting/_instance_not_found.mdx";