mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
80b1b3e04d
Committer: Divya Sharma <divya.sharma@supabase.io> ## 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? Current doc link : https://github.com/supabase/supabase/blob/master/apps/docs/content/guides/platform/upgrading.mdx ## What is the new behavior? Changed the doc to reflect the upgrade process ## Additional context - Added pre-upgrade and post-upgrade best practices - Document upgrade pre-requisites - Re-arranged the sections - removed outdated info <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Restructured the database upgrade guide into a single, explicit step-by-step “How we upgrade” flow * Added new pre-upgrade and post-upgrade best practices sections * Expanded upgrade prerequisites, including read-replica requirements, `pg_upgrade` limitations, and deprecated/unsupported extension guidance * Updated Postgres 17 upgrade guidance, including handling deprecated extensions and `pg_cron`-related implications * Refreshed caveats with updated disk sizing, timing-window details, and restore guidance <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Divya Sharma <divyasharma@Divyas-MacBook-Pro.local> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.