mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 09:59:03 +08:00
08867f94ff
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs restructure of the self-hosting overview: short fit intro, Get started / community listings above the fold, parallel h2 sections for how self-hosting differs (including local development), responsibilities, and telemetry, plus a streamlined support listing with better card content. Closes DOCS-1251. ## What is the current behavior? - Linear item: Explore two PR approaches for the self-hosting page - The self-hosting overview page (`/guides/self-hosting`) is the top search hit for "supabase self-hosting," but reads as a wall of text: three full prose/bullet sections (differs / responsibilities / telemetry) come before the getting-started CTA, which is buried as one small card partway down the page. ## What is the new behavior? - Short fit intro; `self-hosting-get-started` and `self-hosting-community` listings sit directly under the intro. - Top-level h2s for how self-hosting differs, responsibilities, telemetry, and support (no "More about self-hosting" wrapper). - Under differs: rewritten single-project + platform-gap copy, plus `### Not the same as local development` (CLI stack is not a production self-host; points to Docker / community options). - Telemetry clarifies CLI local-dev telemetry vs Docker Compose (no phone-home). - Merged support into a single `self-hosting-support` listing; Enterprise subsection unchanged. - Minor a11y: `aria-hidden` on GlassPanel decorative icon background. ## Additional context - Worktree: `~/GitHub/supabase/supabase-worktrees/nikrichers/docs-1251-self-hosting-inform` - Review: removed the "More about self-hosting" grouping after feedback that it undersold differs / responsibilities. - Companion prototype PR 48416 is closed; this branch is the direction under review. - Verification: | Check | Result | | ----------------------------------------------- | ------------------------------------------------------------------ | | `pnpm lint:mdx content/guides/self-hosting.mdx` | Pass — no errors/warnings on this file | | Vercel docs preview | Pass — full-page after screenshot captured from the preview deploy | ### Proof: intro and get-started above the fold; parallel h2s for differs, responsibilities, and telemetry **Verified:** `pnpm lint:mdx content/guides/self-hosting.mdx` (pass) · Vercel docs preview (pass) ### Before & After | [Before (production)](https://supabase.com/docs/guides/self-hosting) | [After (PR preview)](https://docs-git-nikrichers-docs-1251-self-hosting-inform-supabase.vercel.app/docs/guides/self-hosting) | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | |  |  | ### Test plan - [ ] Visit the preview link and confirm the page opens with intro above the Get started listings - [ ] Confirm parallel h2s for differs / responsibilities / telemetry / support (no "More about self-hosting") - [ ] Confirm "Not the same as local development" distinguishes the CLI stack from self-hosting - [ ] Confirm Support and community is one card grid - [ ] Check mobile width — layout should still be usable - [ ] Confirm `/guides/self-hosting/docker` link still works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Reorganized the self-hosting guide with clearer getting-started resources and community links. - Added dedicated guidance for local development, managed Supabase, telemetry, and self-hosting responsibilities. - Consolidated support resources into one section covering discussions, issues, chat, Reddit, and sharing experiences. - **Accessibility** - Marked decorative icon backgrounds as hidden from assistive technologies. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Nik Richers <nik@validmind.ai> Co-authored-by: Claude <noreply@anthropic.com>
86 lines
2.7 KiB
TypeScript
86 lines
2.7 KiB
TypeScript
import type { ContentListingGroup } from '~/lib/content-listings.schema'
|
|
|
|
export const selfHostingGetStarted: ContentListingGroup = {
|
|
id: 'self-hosting-get-started',
|
|
heading: 'Get started',
|
|
headingLevel: 'h2',
|
|
type: 'grid',
|
|
columns: 2,
|
|
description: 'The fastest and recommended way to self-host Supabase is to use Docker.',
|
|
items: [
|
|
{
|
|
title: 'Docker',
|
|
href: '/guides/self-hosting/docker',
|
|
icon: '/docs/img/icons/docker',
|
|
description: 'Deploy Supabase within your own infrastructure using Docker Compose.',
|
|
badge: 'Official',
|
|
},
|
|
],
|
|
}
|
|
|
|
export const selfHostingCommunity: ContentListingGroup = {
|
|
id: 'self-hosting-community',
|
|
heading: 'Community-driven projects',
|
|
headingLevel: 'h2',
|
|
type: 'grid',
|
|
columns: 2,
|
|
description:
|
|
"There are several other options to deploy Supabase. If you're interested in helping these projects, visit our [Community page](https://supabase.com/contribute).",
|
|
items: [
|
|
{
|
|
title: 'Kubernetes',
|
|
href: 'https://github.com/supabase-community/supabase-kubernetes',
|
|
icon: '/docs/img/icons/kubernetes-icon',
|
|
hasLightIcon: false,
|
|
description: 'Helm charts to deploy a Supabase on Kubernetes.',
|
|
},
|
|
{
|
|
title: 'Traefik',
|
|
href: 'https://github.com/supabase-community/supabase-traefik',
|
|
icon: '/docs/img/icons/traefik-icon',
|
|
hasLightIcon: false,
|
|
description: 'A self-hosted Supabase setup with Traefik as a reverse proxy.',
|
|
},
|
|
],
|
|
}
|
|
|
|
export const selfHostingSupport: ContentListingGroup = {
|
|
id: 'self-hosting-support',
|
|
type: 'grid',
|
|
columns: 2,
|
|
items: [
|
|
{
|
|
title: 'GitHub Discussions',
|
|
href: 'https://github.com/orgs/supabase/discussions?discussions_q=is%3Aopen+label%3Aself-hosted',
|
|
icon: '/docs/img/icons/github-icon',
|
|
description: 'Ask questions, resolve common issues, and make feature requests',
|
|
},
|
|
{
|
|
title: 'GitHub Issues',
|
|
href: 'https://github.com/supabase/supabase/issues?q=is%3Aissue%20state%3Aopen%20label%3Aself-hosted',
|
|
icon: '/docs/img/icons/github-icon',
|
|
description: 'Find out about known issues and workarounds',
|
|
},
|
|
{
|
|
title: 'Discord',
|
|
href: 'https://discord.supabase.com',
|
|
icon: '/docs/img/icons/discord-icon',
|
|
hasLightIcon: false,
|
|
description: 'Connect with other users and get help',
|
|
},
|
|
{
|
|
title: 'Reddit',
|
|
href: 'https://www.reddit.com/r/Supabase/',
|
|
icon: '/docs/img/icons/reddit-icon',
|
|
hasLightIcon: false,
|
|
description: 'Join the official Supabase subreddit',
|
|
},
|
|
{
|
|
title: 'Share your experience',
|
|
href: 'https://github.com/orgs/supabase/discussions/39820',
|
|
icon: '/docs/img/icons/github-icon',
|
|
description: 'Share your self-hosting experience',
|
|
},
|
|
],
|
|
}
|