Skip to content

Commit 7158748

Browse files
committed
Jun's edits to Get started page.
1 parent 07f0c6a commit 7158748

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

src/content/docs/pipelines/get-started.mdx

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,7 @@ head:
1010

1111
import { Render, PackageManagers } from "~/components";
1212

13-
:::note
14-
15-
Pipelines is in **public beta**, and any developer with a [paid Workers plan](/workers/platform/pricing/#workers) can start using Pipelines immediately.
16-
17-
Pipelines lets you ingest real time data streams, such as click events on a website or logs from a service. You can send data to a Pipeline from a Worker, or via HTTP. Pipelines handles batching requests, and scales in response to your workload. Finally, Pipelines delivers the output into R2, as JSON files, automatically handling partitioning and compression for efficient querying.
13+
Pipelines let you ingest real-time data streams, such as click events on a website, or logs from a service. You can send data to a Pipeline from a Worker, or via HTTP. Pipelines handle batching requests and scales in response to your workload. Finally, Pipelines deliver the output into R2 as JSON files, automatically handling partitioning and compression for efficient querying.
1814

1915
By following this guide, you will:
2016

@@ -23,6 +19,10 @@ By following this guide, you will:
2319
3. Post data to it via HTTP.
2420
4. Verify the output file written to R2.
2521

22+
:::note
23+
24+
Pipelines is in **public beta**, and any developer with a [paid Workers plan](/workers/platform/pricing/#workers) can start using Pipelines immediately.
25+
2626
:::
2727

2828
## Prerequisites
@@ -34,46 +34,65 @@ To use Pipelines, you will need:
3434
### 1. Enable Pipelines
3535
TODO
3636

37-
## 1. Setup an R2 bucket to use as a destination
38-
Pipelines is built to ingest data, and store it in an R2 bucket. Create a bucket, following our [Get Started Guide for R2](r2/get-started/) if you need to. Save the bucket name; you'll need it for the next sep.
37+
## 1. Set up an R2 bucket to use as a destination
38+
39+
Pipelines are built to ingest data and store it in an R2 bucket. Create a bucket by following the [get started guide for R2](r2/get-started/).
40+
41+
Save the bucket name for the next step.
3942

4043
## 2. Create a Pipeline
41-
To create a pipeline using Wrangler, run this command in a shell. Specify the name of your pipeline, as well as the name of the R2 bucket you created in Step 1.
44+
45+
To create a Pipeline using Wrangler, run the following command in a the terminal, and specify:
46+
47+
- The name of your Pipeline
48+
- The name of the R2 bucket you created in step 1
4249

4350
```sh
44-
npx wrangler pipelines create <PIPELINE-NAME> --r2 <R2-BUCKET-NAME>
51+
npx wrangler pipelines create [PIPELINE-NAME] --r2 [R2-BUCKET-NAME]
4552
```
4653

47-
Choose a descrpitive name for your Pipeline, related to the type of events you intend to ingest. You cannot change the Pipeline name after you have set it.
54+
When choosing a name for your Pipeline:
4855

49-
Pipeline names must be 1 to 63 characters long. Queue names cannot contain special characters outside dashes (`-`), and must start and end with a letter or number.
56+
1. Ensure it is descriptive and relevant to the type of events you intend to ingest. You cannot change the name of the Pipeline after creating it.
57+
2. Pipeline names must be between 1 and 63 characters long.
58+
3. The name cannot contain special characters outside dashes (`-`).
59+
4. The name must start and end with a letter or a number.
5060

51-
Once your pipeline is created, you'll receive an HTTP endpoint which you can post data to. You should see output which resembles the below:
61+
Once you create your Pipeline, you will receive a HTTP endpoint which you can post data to. You should see output as shown below:
5262

53-
```sh
54-
🌀 Authorizing R2 bucket "<R2-BUCKET-NAME>"
55-
🌀 Creating pipeline named "<PIPELINE-NAME>"
56-
✅ Successfully created pipeline <PIPELINE-NAME> with ID <PIPELINE-ID>
63+
```sh output
64+
🌀 Authorizing R2 bucket "[R2-BUCKET-NAME]"
65+
🌀 Creating pipeline named "[PIPELINE-NAME]"
66+
✅ Successfully created pipeline [PIPELINE-NAME] with ID [PIPELINE-ID]
5767

5868
You can now send data to your pipeline with:
5969
curl "https://<PIPELINE-ID>.pipelines.cloudflare.com/" -d '[{ ...JSON_DATA... }]'
6070
```
6171

6272
## 3. Post data to your pipeline
6373

64-
Use a curl command in your terminal to post an array of JSON objects to the endpoint you received in Step 1.
74+
Use a curl command in your terminal to post an array of JSON objects to the endpoint you received in step 1.
6575

6676
```sh
6777
curl -H "Content-Type:application/json" \
6878
-d '[{"account_id":"test", "other_data": "test"},{"account_id":"test","other_data": "test2"}]' \
6979
<HTTP-endpoint>
7080
```
7181

72-
Once the data has been successfully accepted by the Pipeline, you'll receive a success message.
82+
Once the Pipeline successfully accepts the data, you will receive a success message.
7383

74-
Pipelines handles batching the data, so you can continue posting data to the Pipeline. Once a batch is filled up, the data will be partitioned by date, and written to your R2 bucket.
84+
Pipelines handle batching the data, so you can continue posting data to the Pipeline. Once a batch is filled up, the data will be partitioned by date, and written to your R2 bucket.
7585

7686
## 4. Verify in R2
77-
Navigate to the dashboard for the R2 bucket that you created in step 1. You should see a prefix for today's date. Click through, and you'll see a file created containing the JSON data you sent in Step 3.
7887

79-
By completing this guide, you've got a pipeline, with an HTTP endpoint as a source, and an R2 bucket as a destination.
88+
Go to the R2 bucket you created in step 1 via [Cloudflare dashboard](https://dash.cloudflare.com/). You should see a prefix for today's date. Click through, and you will see a file created containing the JSON data you posted in step 3.
89+
90+
## Summary
91+
92+
By completing this guide, you have:
93+
94+
- Created a Pipeline
95+
- Connected the Pipeline with an R2 bucket as destination.
96+
- Posted data to the R2 bucket via HTTP.
97+
- Verified the output in the R2 bucket.
98+

0 commit comments

Comments
 (0)