Commit Graph

80 Commits

Author SHA1 Message Date
Sebeen Kwon
ab106f6110 docs: fix broken internal links in database and telemetry guides (#46569)
## 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?

Bug fix (documentation) — fixes three internal links that currently 404.

## What is the current behavior?

Three docs pages link to internal paths that do not resolve (no matching
page, and no redirect in `apps/www/lib/redirects.js`):

| File | Link | Problem |
| --- | --- | --- |
| `guides/telemetry/reports.mdx` (×3) |
`/docs/content/guides/database/query-optimization` | Stray `content/`
path segment (the content folder name leaked into the public URL) |
| `guides/database/prisma.mdx` |
`/docs/guides/database/prisma-troubleshooting` | Page lives under the
`prisma/` subfolder |
| `guides/database/postgres/data-deletion.mdx` |
`/docs/blog/postgres-bloat` | Blog posts are served from `/blog`, not
`/docs/blog` |

No related issue — these are self-evident broken links found by checking
every internal `/docs/...` link against the actual pages, the redirects
config, and the dynamic doc routes.

## What is the new behavior?

The links now point to the correct, existing pages:

- `/docs/guides/database/query-optimization` (page:
`apps/docs/content/guides/database/query-optimization.mdx`)
- `/docs/guides/database/prisma/prisma-troubleshooting` (page:
`apps/docs/content/guides/database/prisma/prisma-troubleshooting.mdx`)
- `/blog/postgres-bloat` (post:
`apps/www/_blog/2024-04-26-postgres-bloat.mdx`; consistent with the ~30
other `/blog/...` links across the docs)

Docs-only change; no wording changes beyond the URLs. The `reports.mdx`
tables were re-aligned by Prettier as a result of the shortened links.

## Additional context

For each link I confirmed the target page/post file exists, that the
broken path has no rule in `apps/www/lib/redirects.js`, and that it is
not served by a dynamic Next.js route under `apps/docs/app/`.
2026-06-02 12:34:03 +02:00
Danny White
9c03ad6b02 chore(docs): migrate Admonition labels to titles (#46053)
## What kind of change does this PR introduce?

Docs update. Related to DEPR-551.

## What is the current behavior?

Docs MDX still uses the legacy `label` prop for Admonitions, even though
#45618 added `title` and kept `label` only as a backwards-compatible
alias after #45302 was reverted in #45535.

## What is the new behavior?

Migrates Docs-owned Admonitions from `label=` to `title=` without
changing rendered copy, component APIs, Studio callsites, design-system
examples, or the legacy `label` alias.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Standardized admonition headings across the docs by switching how
admonition headings are provided (preserving all visible guidance and
examples). Content and instructions remain unchanged; this ensures
consistent rendering of callouts and improves uniformity across guides
and reference pages.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46053?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)

<!-- review_stack_entry_end -->
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-05-18 19:00:09 +10:00
Chris Chinchilla
0e736457c8 docs: update docs to reflect new permission models for data api (#45288)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Instructed granting least-privilege table permissions for anon,
authenticated, and service roles prior to enabling Row Level Security
across multiple guides and quickstarts.
* Clarified SQL examples and inline comments, added explicit GRANT steps
and RLS SELECT policies, rephrased policy guidance, and adjusted example
ordering and section numbering for clearer setup and testing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-04-29 06:54:49 +00:00
Chris Chinchilla
1644030dcd docs: RLS and wrapper Key changes (#45166)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated SDK initialization examples to reflect current authentication
patterns across multiple Supabase integration guides
* Enhanced security documentation with expanded guidance on protecting
sensitive credentials like secrets and service role keys in frontend and
Edge Function environments
* Clarified Row-Level Security access patterns and data availability
considerations when using publishable keys

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: fadymak <dev@fadymak.com>
2026-04-24 14:01:44 +00:00
Chris Gwilliams
945b9266bf docs: initial version of doc to guide options for data deletion (#42978)
## 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 update

## What is the current behavior?

Some guidance on deleting objects (and data) with cascading deletes etc

## What is the new behavior?

A guide that covers deleting objects (and data) and the impact that can
have on the DB, as well as ways to mitigate it

## Additional context

Drafted as a similar question about dropping large (>10TB) tables has
been mentioned a few times

---------

Co-authored-by: Jean-Paul Argudo <jean-paul.argudo@supabase.io>
2026-04-17 15:49:44 +00:00
Taryn King
65c6929414 chore(docs): update docs to use postgres over postgresql language (#44881)
## 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?

Updates verbiage throughout docs to use postgres over postgresql.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated terminology throughout documentation, guides, and resources
for consistent product naming across all user-facing materials,
including page titles, descriptions, and reference documentation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-15 09:49:45 +00:00
Copple
973bacf783 docs: Data API IA (#42417)
*Summary*
- reorganize the navigation menu to highlight modules, consolidate API
security content, and move guide entries (auto-generated docs, type
generation, security topics) to the intended sections
- relocate the Data API hardening and custom claims RBAC guides into the
API subtree, updating internal references and redirects, and fixing
cross-links (including adjusting the Security reference order)
- adjust data API topic references (e.g., securing guide and role
management) to point to the new paths and ensure the helper link
ordering follows the requested layout

*Testing*
- Not run (not requested)

Change 1

<img width="1286" height="576" alt="image"
src="https://github.com/user-attachments/assets/d903e9b0-bbfc-403f-bcb9-eee540e466db"
/>

Change 2

<img width="1176" height="666" alt="image"
src="https://github.com/user-attachments/assets/82b3ea4c-b8d4-4cb9-ad90-6c39c8a1a997"
/>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Reorganized API documentation structure, consolidating REST and
GraphQL API guides under a dedicated API section.
* Moved security-related guides to API documentation paths for better
organization.
* Implemented automatic redirects for old documentation links to new
locations.
* Updated navigation menu to reflect the restructured documentation
layout.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-03-11 14:11:26 +01:00
Prashant Sridharan
14d36e9480 Bolt webinar cta page (#43107)
## 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?

New Go landing page for the upcoming Bolt webinar. This is where we will
direct customers who want to learn more to go to request a meeting.

---------

Co-authored-by: Alan Daniel <stylesshjs@gmail.com>
2026-02-24 10:50:54 +00:00
Jeremias Menichelli
f6ec43a9ed [DOCS-454] fix(Docs): Fix images from causing CLS on pages (#43026) 2026-02-23 19:02:31 +01:00
Inian
84ccde68c2 Add auto-enable RLS example to rls docs instead (#42493)
Summary
- move the auto-enable RLS trigger SQL example from the event trigger
guide into the row-level-security guide with a full example
- keep a reference in the event trigger guide that points to the
row-level-security section instead of duplicating the SQL snippet

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Reorganized PostgreSQL Row Level Security documentation with a new
dedicated guide section on automatically enabling RLS for newly created
tables
* Note: Auto-enable RLS applies only to tables created after
installation; existing tables require manual enabling

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-06 10:25:03 +07:00
Elia Tolin
892d2aa3a7 docs: Update custom-claims-and-role-based-access-control-rbac.mdx (#39911)
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-20 22:13:08 +00:00
neinja.dev
1f9b9504a7 docs: Remove the resource that links to the page the user is already on. (#41697)
Removed duplicate link to Row Level Security and Supabase Auth.
2026-01-12 16:03:44 +07:00
Riccardo Busetti
aca93e1ec3 ref(docs): Add supabase_etl_admin role (#41083) 2025-12-05 09:24:48 +01:00
Chris Gwilliams
c7953cff04 docs: add AWS DMS to replication instructions (#40859) 2025-12-04 14:41:01 +02:00
Andrey A.
e5e8432b3a docs: self-hosted database has timezone set to utc (#40200) 2025-11-28 12:50:00 +00:00
Andrew Agostini
5e4e519f6c docs: Fix broken URLS batch 3 (#40508)
* docs: remove link to token-transformer since that repo has since been refactored and no particular file contains the code originally linked to

* docs: update Redis link in rate limiting examples to point to the correct URL

* docs: update Supabase URLs to current magic link docs

* docs: update README for postgres-on-the-edge function to remove polyscale line (service no longer exists) and add resource links to relevant deno blog post

* docs: update Open Graph image generation examples links to the new documentation URL

* docs: update README with new Quickstart: Swift guide URL

* docs: update Supabase Vector links to reflect new URL

* docs: add two new link suggestions the replace the current broken one. Choose one.

* docs: update documentation links for Postgres Language Server to reflect new URL

* docs: update event trigger matrix documentation link to compensate for fact that 'current' verb does not work for some of their links

* Update apps/docs/content/troubleshooting/supabase-grafana-memory-charts.mdx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-28 10:56:17 +00:00
Chris Gwilliams
2415776436 feat: add docs on creating event triggers (#40239) 2025-11-07 20:24:55 +02:00
Monica Khoury
c60d81805d Docs: expand 'Dropping a trigger' section for restricted schemas (#39592) 2025-10-16 12:46:37 +03:00
Laksh Jain
e6548079ed 📚 Docs: Clarify that auth.uid() returns null when unauthenticated in RLS policies (#37336)
* 📚 Fix: Clarify behavior of auth.uid() when unauthenticated in RLS

* Update row-level-security.mdx

* Update row-level-security.mdx

* Update row-level-security.mdx

* Update apps/docs/content/guides/database/postgres/row-level-security.mdx

* Update apps/docs/content/guides/database/postgres/row-level-security.mdx

* Update apps/docs/content/guides/database/postgres/row-level-security.mdx

* Update apps/docs/content/guides/database/postgres/row-level-security.mdx

* Update warning about `auth.uid()` behavior

Clarified behavior of `auth.uid()` when unauthenticated and recommended explicit authentication checks.

* Change admonition type from warning to caution

* Update SQL condition for row-level security

Clarify row-level security SQL condition for unauthenticated users.

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-10-09 08:32:14 +02:00
Jeff Jenkinson
f17ff70309 Update Docs: Adding missing 'to' in NO ACTION and RESTRICT options (#38318)
Adding missing'to' in NO ACTION and RESTRICT options
2025-09-11 16:14:33 +00:00
Charis
47705a8968 chore: replace all supabase urls with relative urls (#38537)
* fix: rewrite relative URLs when syncing to GitHub discussion

Relative URLs back to supabse.com won't work in GitHub discussions, so
rewrite them back to absolute URLs starting with https://supabase.com

* fix: replace all supabase urls with relative urls

* chore: add linting for relative urls

* chore: bump linter version

* Prettier

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-09-09 12:54:33 +00:00
Chris Chinchilla
039e5c0345 docs: Update database settings to connection popup (#38462)
* Draft

* Draft

* Draft

* Draft

* Update apps/docs/content/guides/ai/rag-with-permissions.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

* Update apps/docs/content/guides/database/beekeeper-studio.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

* Update apps/docs/content/guides/platform/read-replicas.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

---------

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
2025-09-08 10:40:25 +00:00
GaryAustin1
f9e5e25a64 Fix security definer RLS example (#37800)
Seems like at some point surrounding the security definer function private.has_good_role() with a select (like all functions should have for RLS) was changed.   I can't find the PR doing it though.
2025-08-12 14:29:39 -04:00
Danny White
d914b81f47 feat: consolidate settings (#37580)
* feat: move storage settings

* feat: redirect

* feat: database settings in service area

* feat: move data api settings

* fix: revert data API placement

* feat: minor UX touches

* fix: simplify configuration group

* feat: references to database settings

* feat: references to storage settings

* fix: redirects and formatting

* fix: Import StorageMenu dynamically to avoid SSR issues with useLocalStorage

* fix: move Data API closer to semantic siblings

* fix: revert smart comma

* Shift bucket sort logic into storage explorer store

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-08-04 16:21:54 +10:00
TheOtherBrian1
a38da5620f Update row-level-security.mdx | correct example (#37361) 2025-07-31 23:19:00 -04:00
Charis
e2fecc0f5d chore(docs linter): bump version (#36715)
* chore(docs linter): bump version

* style: format
2025-07-03 14:46:29 +00:00
Kevin Grüneberg
04c5484bcd docs: fix links (#36595) 2025-06-23 14:40:39 +08:00
Alexkane
4f85284178 Update setup-replication-external.mdx (#36412) 2025-06-16 16:32:10 +00:00
Alexkane
c4316c3ace Update setup-replication-external.mdx (#36382)
Clearer directions around logical replication in PG.
2025-06-13 16:39:29 +00:00
Monica Khoury
2181fed2cd Docs: clarify how to enable column level privileges (#36161) 2025-06-04 12:17:35 -04:00
Chris Gwilliams
34022bd570 Docs: Add section on logical replication for setting up CDC from Supabase to a destination (#27087)
* add replication section with instructions for services

* address comments and neturalise tone

* formalised overview and simplified faq

* reviewdog silenced (mostly)

* move individual tools into tab group and reduce mention of subscriptions

* fix tab components

* correct postgres typos and others

* removed individual service pages and added section for monitoring slots

* update nav menu and add information for monitoring

* update monitoring docs

* added example queries for tracking replication and removed overview

* added spelling rules for Xmin and cleaned up CDC format

* edits & reorganization

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-05-28 11:28:48 +03:00
Charis
6fcb98d927 docs(pg17): add docs on pg17 upgrades (#35431) 2025-05-22 14:07:06 -04:00
Emil
863de8a2e9 update documentation on self-hosted psql timezone management (#35801)
* update documentation on self-hosted psql timezone management

* Update apps/docs/content/guides/database/postgres/configuration.mdx

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-05-21 17:03:59 +00:00
Peter
6a812a04b6 Update docs for new connection strings and disk/compute pages in the dashboard (#35128)
* Update all docs that make references to the database settings to find the connection strings.

Update all docs that references the database settings for the compute and disk page

* run prettier

* run pnpm format instead of prettier directly.

* first run through, fix grammar and reword awkward sentences

* Fix typos and remove unnecessary whitespace

* Apply suggestions from code review

Co-authored-by: Tyler <dshukertjr@gmail.com>

---------

Co-authored-by: Tyler <dshukertjr@gmail.com>
2025-04-21 08:59:43 -05:00
TheOtherBrian1
336ebcfb82 Update timeouts.mdx | modify comment about realtime (#34673) 2025-04-02 11:39:29 -04:00
TheOtherBrian1
339e638536 Update column-level-security.mdx (#34550) 2025-03-31 13:40:09 -04:00
Sabu Siyad
d30478cc22 doc: postgres/row-level-security: wrong link to auth (#33900) 2025-02-27 22:00:58 +00:00
Charis
a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
Charis
16eddf08d6 make rls admonition more prominent with stronger language (#33620) 2025-02-14 10:54:39 -05:00
Bobbie Soedirgo
e319e925a0 chore(docs): update supabase_admin wording (#33584)
* chore(docs): update supabase_admin wording

* chore: add spelling exceptions

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-02-13 15:40:06 +00:00
Charis
2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
TheOtherBrian1
b6a73a391f Update timeouts.mdx | correct timeout limit for service_role (#33246)
* Update timeouts.mdx | correct timeout limit for service_role

* Update timeouts.mdx
2025-02-03 15:01:59 -05:00
Han Qiao
822cf92322 chore: update docs links to database migrations page (#30922) 2024-12-06 11:40:49 +08:00
TheOtherBrian1
f9ccf16e74 added warning to timeout docs (#30869)
* added warning to timeout docs

* Update timeouts.mdx

---------

Co-authored-by: Brian Brennglass <brian@Brians-MacBook-Pro.local>
2024-12-04 15:50:32 -05:00
Charis
4cecae1e09 ci(docs): linter bump version + expand scope (#30860) 2024-12-04 20:37:49 +00:00
Terry Sutton
dd4788bce4 Chore/move advisors (#30283)
* Move advisory things to Advisors page, move schema visualizer to top of database section

* Tiny clean up

* Tiny clean up

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2024-11-05 17:25:23 +08:00
Enzo
2ca63953d6 Include "to authenticated" in example rls policies (#29761)
"To Authenticated"

Update custom-claims-and-role-based-access-control-rbac.mdx and added "to authenticated" in the rls policy which only allows logged in users to query instead of non logged in users as per "Specify roles in your policies" found here supabase.com/docs/guides/database/postgres/row-level-security#specify-roles-in-your-policies
2024-10-08 22:22:10 +00:00
Francesco Sansalvadore
73bbbb798d update docs diagrams (#29394)
* update docs diagrams

* remove unused images
2024-09-19 15:51:45 +02:00
Bulut Yerli
1c1b4c815d Add caution on Update Policy section for need to create Select Policy (#28678)
* Add caution on Update Policy section for need to create Select Policy

* Update apps/docs/content/guides/database/postgres/row-level-security.mdx

---------

Co-authored-by: bulut yerli <bulut@buluts-Mac-mini.local>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-09-18 13:49:08 +00:00
Thomas Vollstädt
da883f7e6a doc: Fix reference to non-existant schema in SQL snippet of "Custom Claims & RBAC" (#28716)
Fix reference to non-existant schema in SQL snippet

The original example snipped references a schema `public.users` that does not exist by default. We could either add it here as well, or simply reference the `auth` schema for simplicity.
2024-09-03 19:35:38 +00:00