Pamela Chia
2536593594
## Summary The CLI now collects usage telemetry (supabase/cli#5019) with opt-out via `supabase telemetry disable` or `SUPABASE_TELEMETRY_DISABLED=1`. The self-hosting docs previously stated "no telemetry" without distinguishing Docker from the CLI. This PR discloses CLI telemetry across docs and regenerates the CLI reference spec to include the new telemetry commands. ## Changes - Update self-hosting telemetry section: Docker has no telemetry, CLI is separate with opt-out instructions and link to full telemetry docs - Regenerate `cli_v1_commands.yaml` from CLI v2.88.0, adding consolidated `supabase telemetry` reference page - Add Telemetry category to `common-cli-sections.json` for CLI reference nav - Add telemetry section to CLI getting-started guide with opt-out commands and env vars ## Testing Tested on Vercel preview: - [x] `/docs/guides/self-hosting#telemetry` renders with CLI telemetry note and link to full docs - [x] `/docs/reference/cli/supabase-telemetry` renders single consolidated reference page - [x] `/docs/guides/local-development/cli/getting-started#telemetry` shows opt-out section ## Linear - fixes GROWTH-754
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.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
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.