mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
SOUFIAN3HM
ebcd052018
## 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 (stale internal links / dead anchors). ## What is the current behavior? The Metrics guide moved from `/docs/guides/platform/metrics` to `/docs/guides/telemetry/metrics` and was split into sub-pages, but 15 internal links across the docs still use the old path: 1. **Redirect chain** — non-anchored links to `/docs/guides/platform/metrics` only resolve via a two-hop permanent redirect (`platform/metrics` → `monitoring-troubleshooting/metrics` → `telemetry/metrics`, in `apps/www/lib/redirects.js`). 2. **Dead anchors** — `#accessing-the-metrics-endpoint` and `#deploying-supabase-grafana` no longer exist on the restructured page, so those links currently land at the top of the page instead of the intended section. ## What is the new behavior? - Non-anchored links now point directly at the canonical `/docs/guides/telemetry/metrics` (relative links use `../telemetry/metrics`), avoiding the redirect chain. - `#accessing-the-metrics-endpoint` links → `/docs/guides/telemetry/metrics` (the Metrics API endpoint access content lives on that page). - `#deploying-supabase-grafana` links → `/docs/guides/telemetry/metrics/grafana-self-hosted`, the page that now holds the Prometheus/Grafana installation instructions those links referenced. 15 files changed, links only — no content changes. ## Additional context Pure documentation link cleanup. Affected files include several guides (`database/connection-management`, `database/inspect`, `platform/performance`, `platform/read-replicas`) and troubleshooting entries that reference the Metrics/Grafana setup guide.
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.