Add page for Snowplow Local #1214
Conversation
✅ Deploy Preview for snowplow-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
We need to be very clear that this isn't official, supported product, despite being called Snowplow Local.
The README has the same info about what's it for, what's it do currently, plus the actual usage instructions. I would leave all that info there, and make this page more about pointing people towards the repo (and comparison with existing Snowplow products)
| @@ -0,0 +1,44 @@ | |||
| --- | |||
| title: "Setting up Snowplow Local" | |||
There was a problem hiding this comment.
I think the page fits better in the API Reference section, below Micro and Mini. Please can you add a couple of details too:
- a paragraph explaining why/when you'd use this pipeline over Micro/Mini
- something about licensing and product support
|
|
||
| Snowplow Local is a local-first limited version of the Snowplow data pipeline that's developer focused by allowing you to run the core Snowplow components locally. | ||
|
|
||
| This includes the Collector and Enricher as well as any of the streaming loaders for loading into BigQuery, Snowflake, Databricks or a data lake. |
There was a problem hiding this comment.
| This includes the Collector and Enricher as well as any of the streaming loaders for loading into BigQuery, Snowflake, Databricks or a data lake. | |
| This includes the Collector and Enrich as well as any of the streaming loaders for loading into BigQuery, Snowflake, Databricks or a data lake. |
|
|
||
| ## What is Snowplow Local? | ||
|
|
||
| Snowplow Local is a local-first limited version of the Snowplow data pipeline that's developer focused by allowing you to run the core Snowplow components locally. |
There was a problem hiding this comment.
what does "developer focused" mean?
|
|
||
| This includes the Collector and Enricher as well as any of the streaming loaders for loading into BigQuery, Snowflake, Databricks or a data lake. | ||
|
|
||
| Snowplow Local represents a quick way to get up and running with minimal effort. It uses Docker Compose to spin up and includes a basic UI to track events so you can see them undergoing enrichment throughout your pipeline in real time. |
There was a problem hiding this comment.
| Snowplow Local represents a quick way to get up and running with minimal effort. It uses Docker Compose to spin up and includes a basic UI to track events so you can see them undergoing enrichment throughout your pipeline in real time. | |
| Snowplow Local uses Docker Compose to spin up and includes a basic UI to track events, so you can see them undergoing enrichment throughout your pipeline in real time. |
|
|
||
| Snowplow Local represents a quick way to get up and running with minimal effort. It uses Docker Compose to spin up and includes a basic UI to track events so you can see them undergoing enrichment throughout your pipeline in real time. | ||
|
|
||
| Although Snowplow Local provides the core software for collecting, enriching, and storing events it only contains a minimal user interface for the control plane. For a more comprehensive UI consider [Snowplow BDP](https://docs.snowplow.io/docs/get-started/snowplow-bdp/) instead. |
There was a problem hiding this comment.
needs screenshot of control plane, info about UI
Thanks - adding it to these docs is part of it becoming an officially supported product, so once this is in I can remove that from the README! I'll revise this version to have more info about the comparisons between the different products. |
Adds a new page to the docs for Snowplow Local