Skip to content

Improving documentation with quickstarts, migrations guides and more #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/images/intro_xata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
193 changes: 181 additions & 12 deletions docs/config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
{
"routes": [
{
"title": "Overview",
"href": "/overview",
"file": "docs/index.mdx"
},
{
"title": "Getting started",
"href": "/getting-started",
Expand All @@ -10,6 +15,28 @@
"href": "/deployment",
"file": "docs/deployment.mdx"
},
{
"title": "Core concepts",
"href": "/core-concepts",
"file": "docs/core-concepts/core-concepts.mdx",
"items": [
{
"title": "Instant branching",
"href": "/core-concepts/branching",
"file": "docs/core-concepts/branching.mdx"
},
{
"title": "Data anonymization",
"href": "/core-concepts/anonymization",
"file": "docs/core-concepts/anonymization.mdx"
},
{
"title": "Schema changes",
"href": "/core-concepts/schema-changes",
"file": "docs/core-concepts/schema-changes.mdx"
}
]
},
{
"title": "Tutorials",
"href": "/tutorials",
Expand All @@ -33,24 +60,166 @@
]
},
{
"title": "Core concepts",
"href": "/core-concepts",
"file": "docs/core-concepts/core-concepts.mdx",
"title": "Quickstarts",
"href": "/quickstarts",
"file": "docs/quickstarts/quickstarts.mdx",
"items": [
{
"title": "Instant branching",
"href": "/core-concepts/branching",
"file": "docs/core-concepts/branching.mdx"
"title": "Astro",
"href": "/quickstarts/astro",
"file": "docs/quickstarts/astro.mdx"
},
{
"title": "Data anonymization",
"href": "/core-concepts/anonymization",
"file": "docs/core-concepts/anonymization.mdx"
"title": "Django",
"href": "/quickstarts/django",
"file": "docs/quickstarts/django.mdx"
},
{
"title": "Schema changes",
"href": "/core-concepts/schema-changes",
"file": "docs/core-concepts/schema-changes.mdx"
"title": "Drizzle",
"href": "/quickstarts/drizzle",
"file": "docs/quickstarts/drizzle.mdx"
},
{
"title": "Go",
"href": "/quickstarts/go",
"file": "docs/quickstarts/go.mdx"
},
{
"title": "GORM",
"href": "/quickstarts/gorm",
"file": "docs/quickstarts/gorm.mdx"
},
{
"title": "Java",
"href": "/quickstarts/java",
"file": "docs/quickstarts/java.mdx"
},
{
"title": "JPA",
"href": "/quickstarts/jpa",
"file": "docs/quickstarts/jpa.mdx"
},
{
"title": "Laravel",
"href": "/quickstarts/laravel",
"file": "docs/quickstarts/laravel.mdx"
},
{
"title": "Next.js",
"href": "/quickstarts/nextjs",
"file": "docs/quickstarts/nextjs.mdx"
},
{
"title": "Node.js",
"href": "/quickstarts/nodejs",
"file": "docs/quickstarts/nodejs.mdx"
},
{
"title": "Nuxt",
"href": "/quickstarts/nuxt",
"file": "docs/quickstarts/nuxt.mdx"
},
{
"title": "Prisma",
"href": "/quickstarts/prisma",
"file": "docs/quickstarts/prisma.mdx"
},
{
"title": "Python",
"href": "/quickstarts/python",
"file": "docs/quickstarts/python.mdx"
},
{
"title": "Rails",
"href": "/quickstarts/rails",
"file": "docs/quickstarts/rails.mdx"
},
{
"title": "Remix",
"href": "/quickstarts/remix",
"file": "docs/quickstarts/remix.mdx"
},
{
"title": "Rust",
"href": "/quickstarts/rust",
"file": "docs/quickstarts/rust.mdx"
},
{
"title": "SQLAlchemy",
"href": "/quickstarts/sqlalchemy",
"file": "docs/quickstarts/sqlalchemy.mdx"
},
{
"title": "SvelteKit",
"href": "/quickstarts/svelte",
"file": "docs/quickstarts/svelte.mdx"
},
{
"title": "TypeORM",
"href": "/quickstarts/typeorm",
"file": "docs/quickstarts/typeorm.mdx"
}
]
},
{
"title": "Migration Guides",
"href": "/migrations",
"file": "docs/migrations/migrations.mdx",
"items": [
{
"title": "AWS Aurora",
"href": "/migrations/aws-aurora",
"file": "docs/migrations/aws-aurora.mdx"
},
{
"title": "AWS RDS",
"href": "/migrations/aws-rds",
"file": "docs/migrations/aws-rds.mdx"
},
{
"title": "Azure Database",
"href": "/migrations/azure",
"file": "docs/migrations/azure.mdx"
},
{
"title": "DigitalOcean Managed Databases",
"href": "/migrations/digitalocean",
"file": "docs/migrations/digitalocean.mdx"
},
{
"title": "GCP Cloud SQL",
"href": "/migrations/gcp-cloudsql",
"file": "docs/migrations/gcp-cloudsql.mdx"
},
{
"title": "Google AlloyDB",
"href": "/migrations/alloydb",
"file": "docs/migrations/alloydb.mdx"
},
{
"title": "Heroku Postgres",
"href": "/migrations/heroku",
"file": "docs/migrations/heroku.mdx"
},
{
"title": "MySQL",
"href": "/migrations/mysql",
"file": "docs/migrations/mysql.mdx"
},
{
"title": "Neon",
"href": "/migrations/neon",
"file": "docs/migrations/neon.mdx"
},
{
"title": "Self-Hosted PostgreSQL",
"href": "/migrations/self-hosted",
"file": "docs/migrations/self-hosted.mdx"
},
{
"title": "Supabase",
"href": "/migrations/supabase",
"file": "docs/migrations/supabase.mdx"
}
]
},
Expand Down
107 changes: 107 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
title: Xata Documentation
---

Xata is a modern PostgreSQL platform designed for developers who want to build faster and ship with confidence. Our platform is built to support your production use cases as well as staging environments and developer workflows with features like instant branching, zero-downtime schema changes, and built-in data anonymization.

Here's a quick introductary video to learn more:

[![Introduction to Xata](assets/images/intro_xata.png)](https://youtu.be/7P5kyzEfAdc?si=WvSdBDBp95vJM91U)

## Why Xata?

| Feature | Description | Benefit | Learn More |
|---------|-------------|---------|------------|
| **🚀 Instant Branching** | Create database branches in seconds, not minutes | Develop and test with production-like data safely | [Branching Guide →](/core-concepts/branching) |
| **⚡ Zero-Downtime Schema Changes** | Modify your database schema without service interruption | Deploy schema changes with confidence | [Schema Changes →](/core-concepts/schema-changes) |
| **🔒 Built-in Data Anonymization** | Automatically anonymize sensitive data for development | Use real data safely in non-production environments | [Anonymization →](/core-concepts/anonymization) |
| **🏗️ Deployment Flexibility** | Choose between SaaS or bring-your-own-cloud (BYOC) | Deploy where you need - managed service or your infrastructure | [Deployment →](/deployment) |

Interested in how we compare against other Postgres solutions out there? Check out this [comparison blog series](https://xata.io/blog/neon-vs-supabase-vs-xata-postgres-branching-part-1) for more details.

## Get Started

Get up and running with Xata in minutes:

1. **[Create your first project](/getting-started)** - Set up a Xata account and create your first database
2. **[Choose your framework](/quickstarts)** - Connect your favorite language or framework

### Popular Quickstarts

| Framework/ORM | Quickstart | Description |
|---------------|------------|-------------|
| **Next.js** | [Get Started →](/quickstarts/nextjs) | Full-stack React applications |
| **Drizzle** | [Get Started →](/quickstarts/drizzle) | TypeScript ORM with type safety |
| **SQLAlchemy** | [Get Started →](/quickstarts/sqlalchemy) | Python SQL toolkit and ORM |
| **Django** | [Get Started →](/quickstarts/django) | Python web framework |

[View all quickstarts →](/quickstarts)

## Tutorials & Guides

| Tutorial | Description |
|----------|-------------|
| **[Set up staging replica](/tutorials/create-staging-replica)** | Create a staging environment with production data |
| **[Migrate to Xata](/tutorials/migrate-to-xata)** | Move your existing database to Xata |
| **[Schema changes workflow](/tutorials/schema-change)** | Learn best practices for schema evolution |

## Migration Guides

Migrate your existing PostgreSQL databases to Xata using `xata clone`:

| Provider | Migration Guide | Description |
|----------|----------------|-------------|
| **AWS RDS & Aurora** | [Migrate →](/migrations/aws-rds) | Amazon's managed PostgreSQL services |
| **GCP Cloud SQL** | [Migrate →](/migrations/gcp-cloudsql) | Google Cloud's managed PostgreSQL |
| **Azure Database** | [Migrate →](/migrations/azure) | Microsoft's managed PostgreSQL service |
| **Neon** | [Migrate →](/migrations/neon) | Serverless PostgreSQL with branching |
| **Supabase** | [Migrate →](/migrations/supabase) | Open source Firebase alternative |

[View all migration guides →](/migrations)

## Tools & Integrations

### Command Line Interface
Manage your Xata databases directly from the terminal:

```bash
# Install Xata CLI
npm install -g @xata.io/cli

# Authenticate and initialize
xata auth
xata init

# Create and manage branches
xata branch create feature-branch
xata branch checkout main
```

[View all CLI commands →](/cli)

### Automation & CI/CD
Integrate Xata into your development workflow:

- **[GitHub Actions](/automations/ga-pr)** - Create database branches for pull requests
- **[Kubernetes](/automations/kubernetes-clone)** - Deploy with container orchestration

[View all automation workflows →](/automations)

### REST API
Programmatically manage your Xata resources:

- **[Organizations](/api/organizations)** - Manage teams and access
- **[Projects](/api/projects)** - Create and configure databases
- **[Branches](/api/branches)** - Branch management operations
- **[Metrics](/api/metrics)** - Performance and usage analytics

## Get Help

- **[Discord Community](https://discord.gg/xata)** - Join 10,000+ developers
- **[GitHub Discussions](https://github.com/xataio/xata/discussions)** - Ask questions and share solutions
- **[Status Page](https://status.xata.io)** - Check service status
- **[Support](https://xata.io/support)** - Enterprise support and consulting

---

*Built with ❤️ by the Xata team*
Loading