Skip to content

Commit 7d4f7c2

Browse files
committed
Updated docs
1 parent 10fe5d6 commit 7d4f7c2

File tree

8 files changed

+25
-11
lines changed

8 files changed

+25
-11
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
# About
3232

33-
Pontoon is an open source, self-hosted, data export platform. We built Pontoon from the ground up for the use case of shipping data products to your enterprise customers. APIs are painful to work with at modern data scale and Pontoon is built to make it easy to sync data directly to your customer's data warehouse. Your customers get their data, without needing to build ETLs or pay for ETL tools, empowering them to make data driven decisions for their business with data from your product. Welcome to the future of customer data syncs 🚀
33+
Pontoon is an open source, self-hosted, data export platform. We built Pontoon from the ground up for the use case of shipping data products to your enterprise customers. APIs are painful to work with at modern data scale and Pontoon is built to make it easy to sync data directly to your customer's data warehouse. Your customers get their data, without needing to build ETLs or pay for ETL tools, empowering them to make data driven decisions for their business, with data from your product. Welcome to the future of customer data syncs 🚀
3434

3535
> Want to get Pontoon up and running in minutes? Try our [Quick Start Guide](https://pontoon-data.github.io/Pontoon/getting-started/quick-start/).
3636
@@ -43,8 +43,8 @@ Pontoon is an open source, self-hosted, data export platform. We built Pontoon f
4343
- **🚀 Easy Deployment**: [Get started](https://pontoon-data.github.io/Pontoon/getting-started/quick-start/) in minutes with Docker or deploy to [AWS Fargate](https://pontoon-data.github.io/Pontoon/getting-started/aws-fargate/)
4444
- **🎯 Major Data Warehouses Integrations**: Supports [Snowflake](https://www.snowflake.com/), [Google BigQuery](https://cloud.google.com/bigquery), [Amazon Redshift](https://aws.amazon.com/redshift/), and [Postgres](https://www.postgresql.org/) as sources and destinations
4545
- **☁️ Multi-cloud**: Send data from any cloud to any cloud. Amazon Redshift ➡️ Google BigQuery? No problem!
46-
- **🏗️ Built for Scale**: Sync over 1 million records per minutea
47-
- **⚡ Automated Syncs**: Schedule data transfers with automatic backfills and incremental loads
46+
- **⚡ Automated Syncs**: Schedule data transfers with automatic backfills. Incremental loads automatically keep destination datasets in sync
47+
- **🏗️ Built for Scale**: Sync over 1 million records per minute
4848
- **✨ Web Interface**: User-friendly dashboard for managing syncs, built with React/Nextjs
4949
- **🔌 REST API**: Programmatic access to all Pontoon features, built with FastAPI
5050

@@ -65,7 +65,7 @@ Pontoon solves these problems with:
6565

6666
- **Direct Warehouse Integration**: Send data directly to customer's data warehouse. No more ETLs needed!
6767
- **Scalable Architecture**: Handle millions of rows efficiently. Say goodbye to rate limits!
68-
- **Scheduled Syncs**: Automate data delivery with automatic backfills on the first sync
68+
- **Automated Scheduled Syncs**: Automatically keep destinations up to date, only syncing data that's changed/new. Backfills are completed on the first sync.
6969
- **Self-Hosted**: Full control over your data and infrastructure
7070

7171
# Is Pontoon Just Another ETL Platform?
@@ -96,7 +96,11 @@ docker run \
9696
ghcr.io/pontoon-data/pontoon/pontoon-unified:latest
9797
```
9898

99-
To view the Web UI: `localhost:3000`. To view the OpenAPI docs / test the API: `localhost:8000/docs`
99+
> Note: If you're using CMD or Powershell, run the command in one line, without `\`
100+
101+
To view the Web UI: `localhost:3000`. To view the OpenAPI docs / test the API: `localhost:8000/docs`.
102+
103+
Check out the [transfer quick start guide](https://pontoon-data.github.io/Pontoon/getting-started/transfer-quick-start/) to add your first source and destination.
100104

101105
## Running Pontoon with Docker Compose
102106

@@ -107,3 +111,7 @@ To build Pontoon from source, use Docker Compose.
107111
```sh
108112
docker compose up --build
109113
```
114+
115+
## Creating Your First Data Export
116+
117+
To quickly set up your first transfer in Pontoon, follow the steps in the [transfer quick start](https://pontoon-data.github.io/Pontoon/getting-started/transfer-quick-start/) guide!
94.6 KB
Loading
75.7 KB
Loading
40 KB
Loading
74.6 KB
Loading

docs/docs/getting-started/docker-compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Deploy Pontoon using Docker Compose for production environments with full contro
44

55
## Prerequisites
66

7-
- **Docker** & **Docker Compose V2** ([Docker Desktop](https://docs.docker.com/compose/install/))
7+
- **Docker** & **Docker Compose V2** ([Install](https://docs.docker.com/compose/install/))
88

99
## Step 1: Clone the Repository
1010

docs/docs/getting-started/quick-start.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ docker run \
2626

2727
Navigate to `http://localhost:3000` to start exploring Pontoon or checkout the API docs at `http://localhost:8000/docs`.
2828

29-
To learn about adding a source, check out the [Sources & Destinations documentation](../sources-destinations/overview.md).
29+
The [Transfer Quick Start Guide](./transfer-quick-start.md) has the next steps for building your first data sync!
30+
31+
To learn more about a specific source or destination, check out the [Sources & Destinations docs](../sources-destinations/overview.md).

docs/docs/getting-started/transfer-quick-start.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ Here's how to quickly set up your first transfer in Pontoon. Follow these steps
66

77
A source defines a connection to a database that holds data you want to sync. For detailed configuration instructions for each source type, see our [Sources & Destinations documentation](../sources-destinations/overview.md).
88

9-
<!-- TODO: Add screenshot of adding a source form -->
10-
119
To add a source:
1210

1311
1. Navigate to the Sources page in the Pontoon web interface
@@ -16,6 +14,8 @@ To add a source:
1614
4. Configure the connection details for your data source
1715
5. Test the connection to ensure it's working properly
1816

17+
![Add Source form](../assets/source-creation.png)
18+
1919
## Step 2: Adding a Model
2020

2121
A model defines a dataset that is ready for export to recipients. Models are multi-tenant, with the `tenant_id` defining which row belongs to which customer.
@@ -30,6 +30,8 @@ When creating a model, you'll need to configure three critical fields:
3030

3131
- **Tenant ID**: An identifier used to associate data with specific customers. This same tenant ID will be used when adding recipients, creating the link between your data and who receives it.
3232

33+
![Add Model form](../assets/model-creation.png)
34+
3335
## Step 3: Adding a Recipient
3436

3537
Recipients are the customers or organizations that will receive your data. Each recipient is associated with a specific tenant ID.
@@ -43,12 +45,12 @@ To add a recipient:
4345
3. Enter the recipient's details including their unique tenant ID
4446
4. Save the recipient configuration
4547

48+
![Add Recipient form](../assets/recipient-creation.png)
49+
4650
## Step 4: Adding a Destination
4751

4852
A destination defines where your data will be sent. This could be a data warehouse or another database.
4953

50-
<!-- TODO: Add screenshot of adding a destination form -->
51-
5254
For detailed configuration instructions for each destination type, see our [Sources & Destinations documentation](../sources-destinations/overview.md).
5355

5456
To add a destination:
@@ -60,6 +62,8 @@ To add a destination:
6062
5. Configure the connection details
6163
6. Test the connection to ensure it's working properly
6264

65+
![Add Destination form](../assets/destination-creation.png)
66+
6367
## Step 5: Begin a Transfer
6468

6569
Once you have configured add a destination, it will kick off an initial sync to backfill data. Click on a destination and navigate to the transfers tab to see the status of the transfer

0 commit comments

Comments
 (0)