Skip to content

docs: say the S3-compatible part is the API, not the storage - #47

Merged
tylere merged 1 commit into
mainfrom
tylere/s3-compatible-wording
Oct 24, 2026
Merged

tylere merged 1 commit into
mainfrom
tylere/s3-compatible-wording

Conversation

@tylere

@tylere tylere commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Two wording fixes about S3 compatibility.

what-is-source.md: "Data on Source is stored in S3-compatible object storage" isn't true for every product. Some products are stored in Azure Blob Storage, which doesn't speak S3 (the same page thanks Azure for hosting). What is S3-compatible is the data proxy's API: the proxy uses multistore, which reads Azure through object_store's native Azure backend and serves the result to clients over the S3 API. The sentence now says that data is served through an S3-compatible API, whichever cloud stores it.

create-an-account.md: the list of things that need an account included "Accessing data programmatically via AWS CLI", but Access Data shows public data working with --no-sign-request and no account. The bullet now says restricted data.

The other mentions of S3 compatibility (data-proxy.md, core-concepts.md, upload/index.md, create-an-account.md's credentials bullet) describe the proxy's API, its clients or its credentials, and still hold.

Data on Source is stored with several providers, including Azure Blob Storage, which does not speak S3. What is S3-compatible is the data proxy's API, which serves every product the same way regardless of where it is stored. what-is-source.md now says that.

create-an-account.md listed AWS CLI access as needing an account, but the Access Data page shows public data working with --no-sign-request. The bullet now says the account is for restricted data.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs-source-coop Ready Ready Preview Oct 24, 2026 12:16am UTC

Request Review

@tylere
tylere merged commit faacd87 into main Oct 24, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
Preview — 03135bc1 Deployed Oct 24, 2026 by vercel[bot]
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