Skip to content

Align Supabase docs with upstream self-hosting - #290

Draft
JackWilb wants to merge 1 commit into
3.0from
codex/supabase-upstream-docs
Draft

JackWilb wants to merge 1 commit into
3.0from
codex/supabase-upstream-docs

Conversation

@JackWilb

Copy link
Copy Markdown
Contributor

Why

Companion to revisit-studies/study#1508. The 3.0 Supabase instructions still tell users to start the bundled Compose stack that the application PR removes.

Architecture

Update the two unversioned Supabase pages to describe the separate, pinned upstream deployment and reVISit's integration files. Link setup, migration, rollback, and ongoing operations to the reviewed application commit; all detailed migration commands remain in the application repository's supabase/ directory. Permanent commit links work before #1508 merges and survive deletion of its branch.

The website explains fresh-only initialization, deployment secrets versus public application settings, anonymous participant sessions, persistent storage, and coordinated backups. Authentication now uses GITHUB_OAUTH_SECRET and explicitly enables the GitHub Compose override. Typedoc is assumed to remain generated by the existing release pipeline.

User-facing impact

New installations follow the supported upstream setup. Existing MinIO/pgsty users get prominent migration and rollback links. Study Designers get matching GitHub authentication instructions.

Validation

  • yarn typecheck passed.
  • yarn build passed, with an optional Vega canvas dependency warning.
  • Checked both generated pages for rendered guide links, internal cross-links, migration warnings, and OAuth settings. All four application-guide URLs returned HTTP 200; linked anchors and override variables match the application source.
  • git diff --check passed.

Risk and rollout

Keep this draft until application PR #1508 lands so the matching support files are available in the normal application checkout. The linked procedures are pinned to application commit 1669a47fa63860b39723b4e92a10f73dbbb8936c; update the links deliberately when adopting a newer procedure. This changes documentation only and targets 3.0.

@github-actions

Copy link
Copy Markdown

Starting deployment of preview ⏳...

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant