Skip to content

Commit bbd7377

Browse files
committed
docs: fixup
1 parent 57a72f9 commit bbd7377

3 files changed

Lines changed: 65 additions & 8 deletions

File tree

docs/.vitepress/theme/style.css

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,59 @@
157157
}
158158

159159
/* Hero heading on homepage */
160-
.VPHero .name,
161-
.VPHero .text {
160+
.VPHero .name {
162161
font-family: var(--vp-font-family-heading) !important;
163162
letter-spacing: -0.03em;
164163
}
165164

165+
/* Hero text — subtitle size (matches default tagline sizing) */
166+
.VPHero .text {
167+
font-family: var(--vp-font-family-base) !important;
168+
font-size: 18px !important;
169+
line-height: 28px !important;
170+
font-weight: 500 !important;
171+
letter-spacing: normal !important;
172+
color: var(--vp-c-text-2);
173+
}
174+
175+
@media (min-width: 640px) {
176+
.VPHero .text {
177+
font-size: 20px !important;
178+
line-height: 32px !important;
179+
}
180+
}
181+
182+
@media (min-width: 960px) {
183+
.VPHero .text {
184+
font-size: 24px !important;
185+
line-height: 36px !important;
186+
}
187+
}
188+
189+
/* Hero tagline — uppercase label */
190+
.VPHero .tagline {
191+
text-transform: uppercase;
192+
font-size: 13px !important;
193+
line-height: 20px !important;
194+
font-weight: 500 !important;
195+
letter-spacing: 0.05em !important;
196+
color: var(--vp-c-text-3) !important;
197+
}
198+
199+
@media (min-width: 640px) {
200+
.VPHero .tagline {
201+
font-size: 14px !important;
202+
line-height: 22px !important;
203+
}
204+
}
205+
206+
@media (min-width: 960px) {
207+
.VPHero .tagline {
208+
font-size: 14px !important;
209+
line-height: 22px !important;
210+
}
211+
}
212+
166213
/* Feature card titles */
167214
.VPFeature .title {
168215
font-family: var(--vp-font-family-heading);

docs/getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
This guide is for administrators setting up and running the Source Data Proxy. If you're a user looking to access data through an existing proxy, see the [User Guide](/guide/).
3+
This guide is for administrators setting up and running their own Source Data Proxy. If you're a user looking to access data through an existing proxy, see the [User Guide](/guide/).
44

55
The Source Data Proxy is a multi-runtime S3 gateway that proxies requests to backend object stores. This guide gets you running locally in minutes.
66

docs/index.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ layout: home
33

44
hero:
55
name: Source Data Proxy
6-
text: Multi-runtime S3 gateway proxy
7-
tagline: A Radiant Earth project. Stream S3-compatible requests to backend object stores with authentication, authorization, and zero-copy passthrough.
6+
text: A multi-runtime S3 gateway proxy with authentication, authorization, and zero-copy passthrough.
7+
tagline: 'Built for reuse. the Source Data Proxy is the backend API powering <a href="https://source.coop">source.coop</a>'
88
actions:
99
- theme: brand
1010
text: User Guide
@@ -33,15 +33,15 @@ features:
3333

3434
## Why a Proxy?
3535

36-
Source Cooperative hosts open data from researchers and organizations around the world. That data lives on object storage — but object storage alone doesn't solve the problems that come with making data truly accessible.
36+
[Source Cooperative](https://source.coop) hosts open data from researchers and organizations around the world. That data lives on object storage — but object storage alone doesn't solve the problems that come with making data truly accessible.
3737

3838
### One URL, any backend
3939

40-
A dataset might start on AWS S3, move to Cloudflare R2 to reduce egress costs, or get mirrored across providers for redundancy. The proxy gives every data product a stable URL (`data.source.coop/{account}/{dataset}/...`) regardless of where the bytes actually live. Backend migrations are invisible to consumers — no broken links, no client reconfiguration.
40+
A dataset might start on AWS S3, move to Cloudflare R2 to reduce egress costs, or get mirrored across providers for redundancy. The proxy gives every data product a stable URL (`data.source.coop/{virtual-bucket}...`) regardless of where the bytes actually live. Backend migrations are invisible to consumers — no broken links, no client reconfiguration.
4141

4242
### Native S3 compatibility
4343

44-
Rather than inventing a new API, the proxy speaks the S3 protocol. This means the entire ecosystem of existing tools — `aws-cli`, `boto3`, DuckDB, the Rust `object_store` crate, GDAL, and hundreds of others — works out of the box. Users don't install a custom client or learn a new SDK. They just set an endpoint URL.
44+
Rather than inventing a new API, the proxy speaks the S3 protocol. This means the entire ecosystem of existing tools — `aws-cli`, `boto3`, DuckDB, the Rust `object_store` crate, the Python `obstore` module, GDAL, and hundreds of others — work out of the box. Users don't install a custom client or learn a new SDK. They just set an endpoint URL.
4545

4646
### Metered access
4747

@@ -77,3 +77,13 @@ flowchart LR
7777
```
7878

7979
The proxy sits between S3-compatible clients and backend object stores. It authenticates incoming requests, authorizes them against configured scopes, and forwards them to the appropriate backend using presigned URLs for zero-copy streaming.
80+
81+
## Get Started
82+
83+
### Access data on Source Cooperative
84+
85+
The [User Guide](/guide/) covers how to interact with Source Cooperative's hosted data proxy at `data.source.coop` — browsing datasets, authenticating, and using standard S3 clients to read and write data.
86+
87+
### Build your own data proxy
88+
89+
The [Administration](/getting-started/) section covers how to deploy and configure the Source Data Proxy for your own project — setting up backends, defining buckets and roles, configuring authentication, and extending the proxy with custom resolvers and providers.

0 commit comments

Comments
 (0)