mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 09:59:03 +08:00
## 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? Adds a cross-link from the Database overview's "Next steps" section to the Deployment & Branching guide, so readers who land on Database looking for Branching docs can find them without guessing at top-level nav. Closes DOCS-1263. ## What is the current behavior? - Linear item: [DOCS-1263](https://linear.app/supabase/issue/DOCS-1263/add-deployment-and-branching-cross-link-on-database-overview-next) - User feedback: someone looking for Branching docs expected them under Products → Database. The canonical docs live under Build → Deployment & Branching (`/guides/deployment`, with Branching at `/guides/deployment/branching`). That placement stays correct (it's a preview/deploy workflow, not a Database product guide) — the miss is that Database overview's "Next steps" grid has no link out to it. ## What is the new behavior? - Added a "Deployment & Branching" card to `databaseNextSteps` in `apps/docs/data/content-listings/database.data.ts`, linking to `/guides/deployment` (the Deployment & Branching hub, not a Branching-only link) - No nav changes, no URL redirects, no Features sidebar work ## Additional context - Worktree: `~/GitHub/supabase/supabase-worktrees/nrichers/docs-1263-add-deployment-branching-cross-link-on-database-overview` - Change is a single data-file addition (`databaseNextSteps` array), rendered on `/guides/database/overview` via `<ContentListings id="database-next-steps" />` - Verification: reviewed diff for correct schema shape (matches existing `ContentListingGroup` items, e.g. the existing cross-product `Backups` → `/guides/platform/backups` entry) ### Proof: Database overview "Next steps" now links out to Deployment & Branching **Verified:** docs preview deploy (pass) · both URLs return `200` · new card renders next to "Roles and permissions" and links to `/guides/deployment` ### Before & After | [Before (production)](https://supabase.com/docs/guides/database/overview) | [After (PR preview)](https://docs-git-nikrichers-docs-1263-add-deployment-br-fd2915-supabase.vercel.app/docs/guides/database/overview) | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | |  |  | - **Before:** https://supabase.com/docs/guides/database/overview - **After:** https://docs-git-nikrichers-docs-1263-add-deployment-br-fd2915-supabase.vercel.app/docs/guides/database/overview ### Test plan - [x] Visit `/guides/database/overview` on the PR preview and confirm the "Next steps" grid shows a **Deployment & Branching** card - [x] Confirm the card links to `/guides/deployment` (not `/guides/deployment/branching`) - [x] Confirm no other Next steps cards, nav items, or redirects changed Co-authored-by: Nik Richers <nik@validmind.ai>
97 lines
3.4 KiB
TypeScript
97 lines
3.4 KiB
TypeScript
import type { ContentListingGroup } from '~/lib/content-listings.schema'
|
|
|
|
export const databaseGetStarted: ContentListingGroup = {
|
|
id: 'database-get-started',
|
|
heading: 'Get started',
|
|
description: "If you're new to the database section, these are the pages to read first:",
|
|
type: 'grid',
|
|
columns: 2,
|
|
items: [
|
|
{
|
|
title: 'Connect to your database',
|
|
href: '/guides/database/connecting-to-postgres',
|
|
description:
|
|
'Connection strings, the Supavisor connection pooler, and when to use direct, transaction, or session mode.',
|
|
},
|
|
{
|
|
title: 'Tables and data',
|
|
href: '/guides/database/tables',
|
|
description: 'Create tables and relationships, and edit rows from the Dashboard.',
|
|
},
|
|
{
|
|
title: 'Import data',
|
|
href: '/guides/database/import-data',
|
|
description: 'Load existing data from CSV files, `pg_dump`, or another Postgres database.',
|
|
},
|
|
{
|
|
title: 'Secure your data',
|
|
href: '/guides/database/secure-data',
|
|
description:
|
|
'Row Level Security (RLS) is how Supabase makes the database safe to query directly from the client. Read this before exposing any table to your app.',
|
|
},
|
|
{
|
|
title: 'Extensions',
|
|
href: '/guides/database/extensions',
|
|
description:
|
|
'Add Postgres extensions from the Dashboard, including `pgvector` for embeddings, `PostGIS` for geospatial data, and `pg_cron` for scheduled jobs.',
|
|
},
|
|
{
|
|
title: 'Run SQL commands',
|
|
href: 'https://supabase.com/dashboard/project/_/sql',
|
|
description: "Use the Dashboard's SQL Editor for ad-hoc queries and saved snippets.",
|
|
},
|
|
],
|
|
}
|
|
|
|
export const databaseNextSteps: ContentListingGroup = {
|
|
id: 'database-next-steps',
|
|
heading: 'Next steps',
|
|
description:
|
|
"Once you've covered the basics, these guides help with other use cases and features:",
|
|
type: 'grid',
|
|
items: [
|
|
{
|
|
title: 'Database functions',
|
|
href: '/guides/database/functions',
|
|
description: 'Run logic inside the database in response to inserts, updates, or deletes.',
|
|
},
|
|
{
|
|
title: 'Triggers',
|
|
href: '/guides/database/postgres/triggers',
|
|
description: 'Run logic inside the database in response to inserts, updates, or deletes.',
|
|
},
|
|
{
|
|
title: 'Database webhooks',
|
|
href: '/guides/database/webhooks',
|
|
description: 'Send row changes to an external HTTP endpoint.',
|
|
},
|
|
{
|
|
title: 'Replication and read replicas',
|
|
href: '/guides/database/replication',
|
|
description: 'Stream changes to other systems or read from a geographically closer replica.',
|
|
},
|
|
{
|
|
title: 'Backups',
|
|
href: '/guides/platform/backups',
|
|
description:
|
|
'Daily backups on every project, with point-in-time recovery on paid plans. Backups cover the database itself; objects stored through the Storage API are not included.',
|
|
},
|
|
{
|
|
title: 'Query performance and optimization',
|
|
href: '/guides/database/query-optimization',
|
|
description: 'Indexes, the query planner, and tools for finding slow queries.',
|
|
},
|
|
{
|
|
title: 'Roles and permissions',
|
|
href: '/guides/database/postgres/roles',
|
|
description: 'The Postgres roles Supabase ships with and how to add your own.',
|
|
},
|
|
{
|
|
title: 'Deployment & Branching',
|
|
href: '/guides/deployment',
|
|
description:
|
|
'Preview environments, branching, migrations, and production readiness for your database changes.',
|
|
},
|
|
],
|
|
}
|