Commit Graph
818 Commits
Author SHA1 Message Date
CoppleandFrancesco Sansalvadore 85a6c5f640 cleans up structure of the docs (#21484)
Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
2024-08-15 07:56:26 +00:00
Joel LeeandStojan Dimitrovski 82f66043c5 feat: add mfa (phone) docs (#28457)
* fix: remove totp relevant questions

* fix: split into two separate pages

* fix: remove non-generic parts

* fix: update docs

* fix: further extract non general sections

* fix: add enrollment flow

* fix: run prettier

* fix: more changese to adjust for vale

* fix: add separate image for phone flow

* fix: update headings

* fix: update link

* fix: edits up to phone auth

* fix: update to make vale happy

* fix: rephrase some sentences

* fix: update phone mfa, remove friendly name specification

* fix: apply suggestions

Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com>

* fix: add section about SIM swapping attacks

* fix: update link for SIM swapping

---------

Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com>
2024-08-14 12:56:21 +00:00
27beb926c0 feat: add third-party auth docs (#28423)
* feat: add third-party auth docs

* add swift example for firebase

* add tpa example for auth0

* add tpa example for cognito

* Add Flutter code block

* Apply suggestions from code review

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Inian <inian1234@gmail.com>

* wip

* rephrase a few things

* apply suggestion from @J0

Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>

---------

Co-authored-by: Guilherme Souza <grsouza@pm.me>
Co-authored-by: dshukertjr <dshukertjr@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Inian <inian1234@gmail.com>
Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>
2024-08-14 12:47:33 +02:00
Charis fc164b5d07 Refactor/app router refs (#28095)
Migrates client SDK References to App Router. (Management and CLI API references aren't migrated yet, nor are self-hosting config references.)

Some notes:

Big changes to the way crawler pages are built and individual section URLs (e.g., javascript/select) are served. All of these used to be SSG-generated pages, but the number of heavy pages was just too much to handle -- slow as molasses and my laptop sounded like it was taking off, and CI sometimes refuses to build it all at all.

Tried various tricks with caching and pre-generating data but no dice.

So I changed to only building one copy of each SDK+version page, then serving the sub-URLs through a response rewrite. That's for the actual user-visible pages.

For the bot pages, each sub-URL needs to be its own page, but prebuilding it doesn't work, and rendering on demand from React components is too slow (looking for super-fast response here for SEO). Instead I changed to using an API route that serves very minimal, hand-crafted HTML. It looks ugly, but it's purely for the search bots.

You can test what bots see by running curl --user-agent "Mozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" <URL_OF_PAGE>

Also added some smoke tests to run against prod for the crawler routes, since we don't keep an eye on those regularly, and Vercel config changes could surprise-break them. Tested the meta images on Open Graph and all seems to work fine.

With this approach, full production builds are really fast: ~5 minutes

Starts using the new type spec handling, which is better at finding params automatically, so I could remove some of the manually written ones from the spec files.
2024-08-13 16:12:59 -04:00
Inian 61359ed68d add custom roles doc to the access security section (#28595)
of the database docs
2024-08-13 15:28:31 +03:00
TheOtherBrian1andBrian Brennglass ee35e989d9 added advanced filtering page to log docs (#28233)
* added advanced filtering page to log docs

* Update advanced-log-filtering.mdx

* Update advanced-log-filtering.mdx

---------

Co-authored-by: Brian Brennglass <brian@Brians-MacBook-Pro.local>
2024-08-13 02:55:07 +00:00
a8f6b74dd3 docs: add http auth hook docs (#25880)
* feat: add http auth hook docs

* fix: add more notes

* fix: add send sms and send email stubs

* fix: add jsonschemas

* fix: add jsonschema for tab

* fix: restructure docs

* feat: add more http examples

* fix: add more examples

* feat: add sql hooks

* fix: patch vale errors

* fix: remove more uses of we

* fix: correct label

* fix: apply suggestions

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* fix: move to shared config

* fix: update mfa and password examples

* fix: add line about jsonschema

* fix: remove HTTP examples for MFA Verification and Password Verification

* chore: update hook secret description

* chore: cleanup overview and add subtitle

* chore: reorganize examples into tabs

* chore: reorganize sections

* chore: format input / outputs into tables

* chore: move each hook into separate pages

* chore: cleanup content

* chore: fix more formatting

* chore: add hooks to sidenav

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Kang Ming <kang.ming1996@gmail.com>
2024-08-12 18:29:27 -07:00
Tyler eb9f0240cb docs: Remove error codes section from Flutter, Swift, and Python reference docs. (#28334)
* exclude dart, python, and swift from error codes menu

* Update the error code doc to be client lib agnostic

* run formatter

* Add a filter to filter out section items

* Update apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefList.tsx

* docs: move error codes table in a separate component

* Add auth error codes section for kotlin
2024-08-06 11:41:10 +09:00
Bo LuandCharis Lam 4c6f93f253 docs: add Snowflake and Paddle foreign data wrappers (#28305)
* docs: add Snowflake and Paddle foreign data wrappers

* docs: add links to left nav menu

* add wasm fdw intro

* fix: inline code wrapping in table cells

* adjust wording

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-08-02 10:37:54 +10:00
CharisandBrian Brennglass a351b10861 adding timeouts to docs (#28197)
* adding timeouts to docs

* edits and rearrangement

* format

---------

Co-authored-by: Brian Brennglass <brian@Brians-MacBook-Pro.local>
2024-07-31 18:25:40 -03:00
Charis e3e8cd943c feat: replace docs command menu with v2 (#28048)
Replace docs command menu with Command Menu V2 from ui-patterns/CommandMenu.

This introduces the prepackaged folder for the shared Command Menu, which contains commands that are shared across the sites (for example, docs search, theme switcher).

Commands that are only applicable to a single site are now defined within that site's own app folder (put them wherever makes sense for your app folder organization, as long as you use the hooks within a global CommandProvider it will work...)

Tested navigating around, using search and AI on laptop and mobile.
2024-07-31 14:20:30 -04:00
Guilherme Souza f9751c2e13 chore: official supabase-py (#28209) 2024-07-29 08:00:48 -03:00
Charis 837e314088 feat(docs): add visual contributing guide (#28214)
Add a contributing guide to docs, which links to resources for contributors
and includes examples of usable components when writing docs content.
2024-07-26 15:54:20 -04:00
Charis 7036596e9d docs: create platform security section for existing security docs (#28195) 2024-07-25 18:22:07 -04:00
karloandCharis a86639e56b Added Flutter guides for Realtime (#28192)
* Added Flutter guides for Realtime

* Update apps/docs/content/guides/realtime/realtime-user-presence.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-07-26 01:41:01 +08:00
Charis 5cd8384bca feat(docs), refactor(docs,studio): add regions list to docs (#28125)
* feat(docs), refactor(docs,studio): add regions list to docs

Adds list of supported AWS regions to docs.

Pulls the region information into `shared-data` package to provide common source of truth for dashboard and docs.

* style: format
2024-07-23 12:45:44 -04:00
Chris Gwilliams 77529b234b Remove mention of safeupdate temporarily (#28013)
remove mention of safeupdate temporarily
2024-07-22 11:42:21 +01:00
Kang Ming dd702704df docs: relocate auth0 migration guide (#28081) 2024-07-19 12:58:51 -04:00
Kevin Grüneberg 3601bb52f5 chore: use type imports / avoid unnecessary API type export (#28088) 2024-07-19 18:35:23 +08:00
Francesco Sansalvadore 62d8c76603 Fix/docs nav widescreen (#28061)
* fix docs nav widescreen spacing

* fix getting started overlap
2024-07-18 10:12:52 +02:00
Francesco Sansalvadore 084294fe79 feat: docs breadcrumbs (#27929)
docs guides breadcrumbs
2024-07-15 10:25:13 +02:00
Kang MingandCharis Lam 51c81c94f0 docs: add migration guide for Auth0 (#27866)
* docs: add migration guide for Auth0

* chore: fix reviewdog

* docs: add reference section

* chore: update heading to h4

* chore: resolved comments & fix some vale errors

* fix: reorg and language

* chore: fix accordion for FAQ

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-07-12 13:06:35 -07:00
Francesco Sansalvadore 0d657df42e feat: docs global top nav (#26917)
Docs global top nav
2024-07-04 11:51:13 +02:00
Ziinc 200481b7a0 docs: log drains documentation (#26370)
* docs: log drains documentation

* docs: pricing update for log drains

* docs: more datadog forwarding behaviour

* docs: move log drains to separate page

* docs: fix naming of provider

* dosc: us spelling

* Revert "docs: pricing update for log drains"

This reverts commit cb5f6ceb5f.

* docs: update links in admonition

* docs: tweak wording

* docs: fix typo

* docs: remove pricing page link

* docs: add elastic filebeat docs

* docs: add generic webhook drain
2024-07-04 09:56:51 +08:00
Charis f4779d4844 refactor: migrate guides to app router (#23101)
Migrate guides to App Router.
2024-07-03 10:25:06 -04:00
Charis 161ba3da32 docs: document more ways to secure the data api (#27756)
Document ways to increase the security of Data API, including:

- Disabling it entirely
- Exposing a custom schema instead of the `public` schema

Also found a duplicated link in the nav for CLS, so removed it.
2024-07-03 12:32:16 +00:00
ce808954df docs: init Realtime authz docs (#22803)
* chore: init Realtime authz docs

* fix: some Vale fixes

* fix: run Prettier

* fix: Prettier

* fix: add note to contact us with placeholder link

* fix: swap rules for policies

* fix: lots of changes

* fix: update for latest Authz model

* fix: nits

* fix: more nits

* fix: nit

* edits

* fix: remove realtime.channel names and fix `in` filters

* fix: caps

* fix: moar

* fix: change h3 to h4

* fix: clarify interaction with postgres_changes

* fix: added simple steps to enable

* Update apps/docs/content/guides/realtime/authorization.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/authorization.mdx

Co-authored-by: Wen Bo Xie <5532241+w3b6x9@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/authorization.mdx

Co-authored-by: Wen Bo Xie <5532241+w3b6x9@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/authorization.mdx

Co-authored-by: Wen Bo Xie <5532241+w3b6x9@users.noreply.github.com>

* fix: add clarity to how it works

* fix: `features` to `extensions`

* fix: clarity

* fix: spelling

* fix: add detail about the test query.

* updates

* updates

* updates

* fix: update schema

* fix: prettier

* fix: rewrite section

* fix: create tables sql

* fix: shorten policy names

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Wen Bo Xie <5532241+w3b6x9@users.noreply.github.com>
Co-authored-by: Wen Bo Xie <wenbo.xie3@gmail.com>
2024-07-02 14:46:29 -04:00
Guilherme Souza 5e8efeb415 docs: add quickstart for iOS and SwiftUI (#27535) 2024-06-25 14:24:32 -03:00
Charis ac192a5024 refactor(docs): migrate home page to app router (#27221) 2024-06-24 18:47:53 -04:00
Lakshan Perera cf0ed10e1f fix: update edge function logging & troubleshooting guides (#27265) 2024-06-14 11:50:31 +02:00
Lakshan Perera a3d1f87a09 chore: change Edge Function guide's sidebar titles (#27218) 2024-06-12 17:04:06 +00:00
karlo 1469f543ae Added Debugging Section for Realtime (#27165) 2024-06-12 05:01:28 +08:00
Kang Ming f205b95e22 docs: update auth ui (#27158) 2024-06-11 01:41:35 +08:00
karlo 64fa8721b6 chore: Add Operational Error Codes for Realtime (#27110) 2024-06-09 09:21:15 +08:00
Thor 雷神 Schaeff dda1c05ebd docs: Debugging Edge Functions with Inspector (#27014)
* chore: update ai types.

* docs: start ef inspector docs.

* chore: break out into own page.

* chore: spelling.

* chore: chrome devtools only.
2024-06-06 17:21:36 +08:00
Thor 雷神 SchaeffandCharis 1a571a2368 docs: edgy bedrock. (#26909)
* docs: edgy bedrock.

* fix: nav.

* Apply suggestions from code review

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-06-01 22:28:39 +08:00
Lakshan Perera a133a111d2 Some updates to Edge Functions guides (#26877)
* chore: link to Sentry guide from Debugging section

* chore: Change Edge Function Quickstart to Get started

This section isn't much of a quickstart. Updated the first guide title
to "Create an Edge Function"

* chore: moved Edge Functions limits to a separate page

* chore: added a page on HTTP Status codes Edge Functions can return
2024-05-30 16:56:32 -02:30
Francesco Sansalvadore 511e7c728c docs: fix broken links (#26711)
* fix rest api docs nav links

* remove unused data-apis page
2024-05-24 11:09:11 +02:00
Francesco SansalvadoreandJonathan Summers-Muir 9c4eb2c2eb docs icons inconsistencies (#26715)
* fix docs inconsistent icons

* remove redundant and old icons

* revert links change

* fix prev link

* Apply suggestions from code review

---------

Co-authored-by: Jonathan Summers-Muir <MildTomato@users.noreply.github.com>
2024-05-24 07:04:22 +00:00
Greg RichardsonandCharis 3f1df65bba SQL to REST translator (#25978)
* feat: sql-to-rest poc

* feat: sql-to-supabase-js poc

* chore: upgrade to libpg-query@15

* feat: sql-to-rest docs tool

* docs(sql-to-rest): add introduction

* docs: wording improvements

* fix: theme

* chore: tailwind placeholder

* feat(sql-to-rest): limit, offset, and range

* feat(sql-to-rest): sort by

* fix(sql-to-rest): ui theme

* feat(sql-to-rest): casts

* feat(sql-to-rest): dynamic faqs in ui

* feat(sql-to-rest): improve ui responsiveness

* feat(sql-to-rest): more advanced faqs in ui

* feat(sql-to-rest): http and curl syntax highlighting

* feat(sql-to-rest): baseUrl in http/curl rendering

* docs(sql-to-rest): clarification on curl flags

* feat(sql-to-rest): more faqs

* refactor(sql-to-rest): split faqs into own file

* refactor(sql-to-rest): move formatters to sql-to-rest package

* docs(sql-to-rest): move page to new tools section

* feat(sql-to-rest): joins and resource embeddings

* chore(sql-to-rest): rename 'convert' to 'translate'

* feat(sql-to-rest): add faqs

* feat(sql-to-rest): ui improvements

* feat(sql-to-rest): faq title adjustment

* feat(sql-to-rest): link to client lib docs

* feat(sql-to-rest): assumptions

* feat(sql-to-rest): friendly 'not supported yet' errors

* feat(sql-to-rest): json columns

* feat(sql-to-rest): remove curl -G flag if unused

* feat(sql-to-rest): better error handling

* chore: revert accidental rls ai work

* fix: build errors

* fix(sql-to-rest): theme

* feat(sql-to-rest): change base url

* feat(sql-to-rest): basic aggregate poc

* feat(sql-to-rest): group by

* feat(sql-to-rest): more group by checks

* feat(sql-to-rest): count(*) special case

* fix(sql-to-rest): tests

* feat(sql-to-rest): faq on 'and' operator

* fix(sql-to-rest): error messages

* fix(sql-to-rest): multiple filters on same column

* refactor(sql-to-rest): error hints

* feat(sql-to-rest): match and imatch

* feat(sql-to-rest): in operator

* feat(sql-to-rest): parsing error hints

* feat(sql-to-rest): default language to curl

* feat(sql-to-rest): format on cmd+s

* feat(sql-to-rest): format initial value

* fix(sql-to-rest): turn off tab query group

* feat(sql-to-rest): improve wording in error messages

* feat(sql-to-rest): animated code blocks

* feat(sql-to-rest): more error hints

* fix(sql-to-rest): strip primary relation prefix from columns

* feat(sql-to-rest): json column in order by clause

* feat(sql-to-rest): validate all referenced relations exist in from clause

* refactor(sql-to-rest): split core sql-to-rest lib into separate repo

* feat(sql-to-rest): upgrade to v0.1.1

* feat(sql-to-rest): upgrade to v0.1.2

* feat(sql-to-rest): upgrade to v0.1.4

* chore: upgrade libpg-query

* feat: update 'create a pr' link

* fix: app builds

* fix: prettier

* fix: typecheck

* fix: studio tests

* chore: remove console.log

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* docs(sql-to-rest): remove broken link to client libraries

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-22 12:37:01 -06:00
karlo fc99675c4d chore: Update Realtime Nav constants (#25967) 2024-05-09 11:44:19 -07:00
ec86bbc4fe feat: new auth ia (#22812)
Co-authored-by: Kang Ming <kang.ming1996@gmail.com>
Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>
2024-05-07 20:15:06 +00:00
Charis 12c5eb44b2 fix(docs): rename database linter (#23274) 2024-04-25 17:20:58 +00:00
fe2e8704f7 Remove TCE Blog & Mark pgsodium as not recommended in docs (#22217)
* remove TCE blog

* update pgsodium docs that its pending deprecation

* Update apps/docs/content/guides/database/extensions/pgsodium.mdx

Co-authored-by: Greg Richardson <greg.nmr@gmail.com>

---------

Co-authored-by: Rodrigo Mansueli <rodrigo@mansueli.com>
Co-authored-by: Greg Richardson <greg.nmr@gmail.com>
2024-04-24 19:10:25 +00:00
Charis 3f69fdf5c0 fix: docs build (#23227) 2024-04-24 11:46:36 -04:00
Joseph SchultzandCharis fa8167b26c chore: Update C# docs to reflect new Nuget Package names and Changelog (#23148)
* Refresh of c# client docs to reflect Supabase@v1.0.0 and new Nuget Package Names

* Clarify maintainers and contributors

* Separate C# v0 and v1 references

* Format

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-23 21:07:29 +00:00
Charis 7e8c07227b fix: cleanup orphan pages (#23200) 2024-04-23 16:16:57 -04:00
Charis 0c8f9942cf feat(understandability): add new server-side auth docs for sveltekit (#22574)
End-to-end guide for setting up Server-Side Auth with SvelteKit, covering:

- Protected routes
- Signin, signup, signout
- Protected data
2024-04-22 18:26:27 +00:00
Wen Bo XieandCharis Lam d56f340190 fix: redirect column level security guide to the new home (#22930)
* fix: redirect column level security guide to the new home

* fix: docs nav menu wrong link

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-04-19 22:37:24 +00:00
Rodrigo MansueliandCharis 134a13f835 feat: storage egress guide (#22807)
* feat: storage egress guide

* typo + prettier

* Update bandwidth.mdx

* Update bandwidth.mdx

* Update bandwidth.mdx

* Update apps/docs/content/guides/storage/serving/bandwidth.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-19 11:39:07 +00:00