Skip to content

Commit ce52cf2

Browse files
docs: modernize contributor docs and domain/contact references (#4775)
Co-authored-by: Simon Kohnstamm <kohnsts@gmail.com>
1 parent a05b8e8 commit ce52cf2

File tree

21 files changed

+164
-42
lines changed

21 files changed

+164
-42
lines changed

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Quilt: Scientific Data Management on AWS
2+
3+
[![Docs](https://img.shields.io/badge/Docs-docs.quilt.bio-0B5FFF?style=for-the-badge)](https://docs.quilt.bio/)
4+
[![Join Office Hours](https://img.shields.io/badge/Join%20Office%20Hours-Live%20Friday-00875A?style=for-the-badge)](https://riverside.com/webinar/registration/eyJzbHVnIjoic2ltb24ta29obnN0YW1tcy1zdHVkaW8iLCJldmVudElkIjoiNjk5Y2M5MDI4YjVkM2Y2MjFjYTk5MzgzIiwicHJvamVjdElkIjoiNjk5Y2M5MDI1OTE5NDU0YmNlOWEzZDVmIn0=)
5+
[![Book an Intro](https://img.shields.io/badge/Book%20an%20Intro-Meet%20the%20Team-5E4AE3?style=for-the-badge)](https://www.quilt.bio/meetings/simon-kohnstamm/quilt-introduction)
6+
7+
Quilt is a **Scientific Data Management Platform on AWS** that helps teams and
8+
AI find, trust, and reuse data through deeply versioned, context-rich data
9+
packages.
10+
11+
Most scientific organizations do not struggle to generate data. They struggle
12+
to keep it usable over time. As teams, tools, and workflows evolve, context
13+
gets lost, scientists cannot find what they need, data teams get pulled into
14+
manual support, and AI projects slow down because data lacks structure,
15+
lineage, and trust.
16+
17+
Quilt solves this by turning cloud data into durable, searchable, reusable
18+
packages. Each package captures data plus metadata, documentation, lineage, and
19+
version history needed for confident reuse. Built on AWS, Quilt works with data
20+
in place, so organizations can improve data management without disruptive
21+
migrations or rigid workflows.
22+
23+
## Open Source and Enterprise
24+
25+
Quilt includes both open-source software and an enterprise platform deployment model.
26+
27+
- **Open source (this repository):**
28+
- Python SDK and CLI for creating Quilt packages, installing packages
29+
locally, and uploading packages to S3 using your AWS credentials
30+
- Package versioning, reproducibility, and documentation workflows that fit
31+
data science and bioinformatics workloads
32+
- Does **not** provide the full hosted search and visualization experience
33+
for package discovery and collaboration
34+
- **Enterprise platform:**
35+
- Dedicated AWS-hosted Quilt platform for teams to search, share, and
36+
visualize Quilt packages
37+
- Multi-user collaboration and governance features on top of open-source
38+
package workflows
39+
40+
Start with:
41+
42+
- Open-source docs: [`docs/README.md`](docs/README.md)
43+
- Enterprise administration docs: [`docs/technical-reference.md`](docs/technical-reference.md)
44+
- Contributor guide: [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md)
45+
46+
## Repository Map
47+
48+
Use this to find where each major part of Quilt lives.
49+
50+
| Path | What it contains |
51+
| --- | --- |
52+
| `api/python` | `quilt3` Python SDK, CLI, and Python tests |
53+
| `catalog` | Quilt web catalog frontend (TypeScript/JavaScript) |
54+
| `lambdas` | AWS Lambda services (indexing, previews, events, etc.) |
55+
| `shared` | Shared schemas and cross-component assets |
56+
| `py-shared` | Shared Python utilities used by services |
57+
| `s3-proxy` | S3 proxy service components |
58+
| `docs` | Product, platform, API, and contributor documentation |
59+
| `gendocs` | API documentation generation tooling |
60+
| `testdocs` | Documentation codeblock validation tools |
61+
62+
## Quick Start for Contributors
63+
64+
1. Clone and create a branch:
65+
66+
```bash
67+
git clone https://github.com/quiltdata/quilt
68+
cd quilt
69+
git checkout -b my-change
70+
```
71+
72+
2. Install Python task runner:
73+
74+
```bash
75+
# macOS/Linux
76+
curl -LsSf https://astral.sh/uv/install.sh | sh
77+
```
78+
79+
3. Run Python tests:
80+
81+
```bash
82+
cd api/python
83+
uv run poe test
84+
```
85+
86+
4. Run catalog locally:
87+
88+
```bash
89+
cd catalog
90+
npm install
91+
npm start
92+
```
93+
94+
For full setup, testing, and release steps, see [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md).
95+
96+
## Learn More
97+
98+
- Product docs: [docs.quilt.bio](https://docs.quilt.bio/)
99+
- Open data demo catalog: [open.quiltdata.com](https://open.quiltdata.com/)
100+
- Case studies and customer stories: [quilt.bio/case-studies](https://www.quilt.bio/case-studies)
101+
- Slack community: [Join Quilt Slack][quilt-slack]
102+
103+
[quilt-slack]: https://slack.quilt.bio

api/python/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires-python = ">=3.9"
1111
license = "Apache-2.0"
1212
license-files = ["LICENSE"]
1313
authors = [
14-
{ name = "quiltdata", email = "contact@quiltdata.io" },
14+
{ name = "quiltdata", email = "support@quilt.bio" },
1515
]
1616
classifiers = [
1717
"Development Status :: 5 - Production/Stable",

catalog/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
FROM amazonlinux:2023.9.20251208.0
2-
MAINTAINER Quilt Data, Inc. contact@quiltdata.io
2+
MAINTAINER Quilt Data, Inc. support@quilt.bio
33

44
ENV LC_ALL=C.UTF-8
55
ENV LANG=C.UTF-8

catalog/app/constants/urls.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
/* Constants are a developer's best friend
22
* convention: camelcase, no terminating slash */
3-
export const blog = 'https://blog.quiltdata.com'
3+
export const blog = 'https://blog.quilt.bio'
44
export const docs = 'https://docs.quilt.bio'
55
export const gitWeb = 'https://github.com/quiltdata/quilt'
6-
export const homeMarketing = 'https://quiltdata.com'
6+
export const homeMarketing = 'https://quilt.bio'
77
export const instagram = 'https://www.instagram.com/quiltdata/'
88
export const jobs = 'https://quilt-data.breezy.hr/'
99
export const linkedin = 'https://www.linkedin.com/company/quilt-data'
10-
export const slackInvite = 'https://slack.quiltdata.com/'
10+
export const slackInvite = 'https://slack.quilt.bio'
1111
export const icon256 = 'https://d1zvn9rasera71.cloudfront.net/q-256-square.png'
1212
export const tutorial =
1313
'https://github.com/quiltdata/quilt/blob/master/README.md#tutorial'

catalog/app/containers/Auth/ActivationError.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React from 'react'
22

33
import * as Layout from './Layout'
44

5-
const SUPPORT_EMAIL = 'support@quiltdata.io'
5+
const SUPPORT_EMAIL = 'support@quilt.bio'
66

77
const Container = Layout.mkLayout('Activation Error')
88

catalog/app/website/pages/Install/Install.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const MP_LINK =
1212
'https://aws.amazon.com/marketplace/pp/Quilt-Data-Quilt-Business/B07QF1VXFQ'
1313
const PREREQ_LINK =
1414
'https://docs.quilt.bio/references/technical-reference#before-you-install-quilt'
15-
const MAILTO = 'mailto:contact@quiltdata.com'
15+
const MAILTO = 'mailto:support@quilt.bio'
1616

1717
const useStyles = M.makeStyles((t) => ({
1818
container: {

catalog/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"npm": "10",
1111
"node": "20"
1212
},
13-
"author": "Quilt Data, Inc. <contact@quiltdata.io> (https://quiltdata.com)",
13+
"author": "Quilt Data, Inc. <support@quilt.bio> (https://quilt.bio)",
1414
"license": "MIT",
1515
"scripts": {
1616
"analyze:clean": "rimraf stats.json",

docs/CONTRIBUTING.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ Quilt is an open source project, and we welcome contributions from the community
44

55
Contributors must adhere to the [Code of Conduct](https://github.com/quiltdata/quilt/blob/master/docs/CODE_OF_CONDUCT.md).
66

7+
If you are looking for a quick map of where major components live, start with the
8+
repository [`README.md`](../README.md).
9+
710
## Reporting issues
811

9-
Unsure about something? To get support, check out our [Slack channel](https://quiltusers.slack.com/messages).
12+
Unsure about something? To get support, check out our [Slack community](https://slack.quilt.bio).
1013

1114
Found a bug? File it in our [GitHub issues](https://github.com/quiltdata/quilt/issues).
1215

@@ -28,6 +31,13 @@ git checkout -B new-branch-name
2831

2932
## Local package development
3033

34+
Choose your area first:
35+
36+
- Python SDK and CLI work: `api/python`
37+
- Web catalog work: `catalog`
38+
- AWS services and background processing: `lambdas`
39+
- Platform and user docs: `docs`
40+
3141
### Python Environment
3242

3343
We use [`uv`](https://github.com/astral-sh/uv) for dependency management.
@@ -41,7 +51,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
4151
pip install uv
4252
```
4353

44-
`uv` ensures the environemnt is properly set up before executing a command,
54+
`uv` ensures the environment is properly set up before executing a command,
4555
so you don't have to do anything else.
4656

4757
Run `uv run poe` to see all configured tasks (or refer to `pyproject.toml`).
@@ -92,7 +102,12 @@ To build a static code bundle, as would be necessary in order to serve the catal
92102
npm run build
93103
```
94104

95-
<!-- TODO: add configuration instructions -->
105+
To run the catalog locally, create a development config:
106+
107+
```bash
108+
cp config.js.example static-dev/config.js
109+
# edit static-dev/config.js for your environment
110+
```
96111

97112
To run the catalog in developer mode:
98113

docs/Catalog/Admin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ By default, when you add a bucket to the Quilt stack one of two things will happ
9595

9696
If either of the above conditions fails, Quilt will not add the bucket in question.
9797

98-
See [S3 Events, EventBridge](EventBridge.md) for more.
98+
See [S3 Events, EventBridge](../EventBridge.md) for more.
9999

100100
## Settings
101101

docs/Catalog/Installation.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@ We recommend that all users do one or more of the following:
2121
* [Schedule a Quilt engineer](https://calendly.com/d/g6f-vnd-qf3/engineering-team)
2222
to guide you through the installation
2323

24-
* [Join Quilt on Slack](https://slack.quiltdata.com/) to ask questions and
25-
connect with other users
24+
* [Join Quilt on Slack][quilt-slack] to ask questions and connect with other
25+
users
2626

27-
* [Email Quilt](mailto:contact@quiltdata.io)
27+
* [Email Quilt](mailto:support@quilt.bio)
28+
29+
[quilt-slack]: https://slack.quilt.bio
2830

2931
## Requirements and Prerequisites
3032

@@ -106,7 +108,7 @@ recommend that you [contact us first](#help-and-advice).
106108
107109
### AWS Service Catalog
108110
109-
1. Email [contact@quiltdata.io](mailto:contact@quiltdata.io)
111+
1. Email [support@quilt.bio](mailto:support@quilt.bio)
110112
with your AWS account ID to request access to Quilt through the
111113
AWS Service Catalog and to obtain a license key.
112114
1. Click the service catalog link that you received from Quilt.

0 commit comments

Comments
 (0)