mirror of
https://github.com/supabase/supabase.git
synced 2026-10-14 05:39:11 +03:00
Miranda Limonczenko
0d465e7b5f
Closes FE-3966 ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem - The admonition uses both 'tip' and 'note', but the visual distinction has long-ago collapsed. - 'Note' is used far more frequently than 'tip' - The two are very similar and it is confusing to know which one to use when they are visually identical ## Solution Collapse 'tip' and 'note' into one by removing all places where there is 'tip' and updating all references to 'tip' into 'note'. **Note:** This PR also resolves new broken links flagged by the E2E docs checker. It may move to another PR since E2Es keep erroring. ### Specific changes See below for an AI-generated list of changes: - **Type system** — removed `'tip'` from `AdmonitionType`, its `TYPE_TO_VARIANT`/`TYPE_LABEL` entries, and the test case in [`packages/ui-patterns/src/Admonition/](packages/ui-patterns/src/Admonition/) - **Remark plugin** — [remarkAdmonition.ts](apps/docs/lib/mdx/plugins/remarkAdmonition.ts) now maps mkdocs `tip` → `note` - **Lint allowlist** — `tip` dropped from `supa-mdx-lint.config.toml` - **Content migration** — all 109 files with `type="tip"` (across `apps/docs`, `apps/www`, `apps/studio`) converted to `type="note"`; zero remaining hits confirmed by repo-wide grep - **Style guide** — `CONTRIBUTING.md` and `contributing/content.mdx` updated to describe 4 admonition types instead of 5 ### Usage before implementation See the usage table that points toward 'note' as being dominant across all apps: Here's the usage table: | Location | `note` | `tip` | |---|---|---| | apps/docs | ~480 | ~143 | | apps/studio | 34 | 6 | | apps/www (blog) | 19 | 3 | | packages/ui-patterns (tests) | 3 | 1 (parametrized) | | design-system / ui-library / packages/ui / packages/common | 0–1 (test fixture only) | 0 | ## Preview links | App | Page | Search text (Ctrl+F) | Verify | |---|---|---|---| | docs | [/docs/guides/ai-tools/byo-mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/byo-mcp) | official MCP TypeScript SDK | callout's aria-label="Note" | | docs | [/docs/guides/ai-tools/mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/mcp) | MCP server is available at | callout's aria-label="Note" | | docs | [/docs/guides/ai/python-clients](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai/python-clients) | Click Connect at the top of any project page | callout's aria-label="Note" | | docs | [/docs/guides/auth/audit-logs](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/auth/audit-logs) | Disabling Postgres storage reduces your database storage costs | callout's aria-label="Note" | | docs | [/docs/guides/database/tables](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/database/tables) | access a custom schema through the Supabase Data API | callout's aria-label="Note" | | docs | [/docs/guides/troubleshooting/edge-function-404-error-response](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/troubleshooting/edge-function-404-error-response) | Always configure an appropriate time frame | callout's aria-label="Note" (was single-quoted type='tip') | | www | [blog: cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code) | Detecting config drift | callout's aria-label="Note" | | www | [blog: cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code) | Setting Edge Function secrets | callout's aria-label="Note" | | www | [blog: nosql-mongodb-compatibility-with-ferretdb-and-flydotio](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/nosql-mongodb-compatibility-with-ferretdb-and-flydotio) | If your network supports IPv6 connections | callout's aria-label="Note" | Note: the `www` rows use the `zone-www-dot-com` preview host, not the `docs` one you gave — since blog pages are served from the www app, not docs. ## Manual testing 1. Open preview links for affected pages. 2. Inspect. Open console. 3. Paste the following in and see there is no 'Tip' on the page: ``` document.querySelectorAll('[role="alert"]').forEach(el => console.log(el.getAttribute('aria-label'), el.textContent.slice(0,60))) ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized informational callouts across docs and tutorials from **“Tip”** to **“Note”**, updating multiple examples and guidance blocks. * Updated a few related doc references/links and conditional “Next steps” content. * **UI Updates** * Switched various in-app banners and notices to the **“Note”** style variant. * **Bug Fixes / Improvements** * Removed support for the retired **“Tip”** callout type and aligned docs linting, component behavior, and aria labeling to the remaining admonition types. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
53 lines
2.3 KiB
Plaintext
53 lines
2.3 KiB
Plaintext
---
|
|
id: 'storage-management'
|
|
title: 'Download Objects'
|
|
description: 'Learn about downloading objects'
|
|
subtitle: 'Learn about downloading objects'
|
|
sidebar_label: 'Download Objects'
|
|
---
|
|
|
|
You can download Supabase Storage files can in a variety of ways depending on your use case.
|
|
|
|
## From the Dashboard
|
|
|
|
You can download individual files directly from the [**Storage > Files**](/dashboard/project/_/storage/buckets) section of the Dashboard by browsing to your bucket and selecting files.
|
|
|
|
## Using the Supabase CLI
|
|
|
|
You can use the `supabase storage` commands to list and copy objects from your linked project.
|
|
|
|
See the [CLI reference](/docs/reference/cli/supabase-storage) for available commands.
|
|
|
|
## Using an S3-compatible client
|
|
|
|
Supabase Storage exposes an S3-compatible endpoint, which means you can use tools like [Cyberduck](https://cyberduck.io/) (via a connection profile), AWS CLI, or rclone to browse and download your files.
|
|
|
|
To connect:
|
|
|
|
1. Go to [**Storage > Configuration > S3**](/dashboard/project/_/storage/s3) section of the Dashboard.
|
|
2. Enable the S3 protocol and generate an access key + secret key pair (Save it immediately as it is shown once).
|
|
3. Use your S3-compatible tool with the endpoint and credentials from the Dashboard.
|
|
|
|
See the [S3 authentication doc](/docs/guides/storage/s3/authentication) for full connection details.
|
|
|
|
<Admonition type="note">
|
|
|
|
For downloading a large number of objects, using an S3-compatible tool like rclone or Cyberduck is significantly more efficient than downloading files individually.
|
|
|
|
</Admonition>
|
|
|
|
## Using migration scripts
|
|
|
|
For bulk downloads or project migrations, you can use the scripts from our migration docs:
|
|
|
|
- **Node.js script** — see "Migrating storage objects" in the [migration guide](/docs/guides/platform/migrating-within-supabase/backup-restore)
|
|
- **Google Colab script** — see "Migrate storage objects to new project's S3 storage" in the [dashboard restore guide](/docs/guides/platform/migrating-within-supabase/dashboard-restore)
|
|
|
|
## File metadata
|
|
|
|
<Admonition type="note">
|
|
|
|
File metadata is stored separately from the actual files. It lives in the `storage.buckets` and `storage.objects` tables in your Postgres database. If you need a complete backup (files + metadata), see the [backup and restore guide](/docs/guides/platform/migrating-within-supabase/backup-restore).
|
|
|
|
</Admonition>
|