Initial Signals Docs #1197
10000Initial Signals Docs #1197
Conversation
✅ Deploy Preview for snowplow-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
f40a7bc to
db48419
Compare
db48419 to
321d5d5
Compare
docs/signals/attributes/index.md
Outdated
| | `events` | List of Snowplow Events that the Attribute is calculated on | List of `Event` type | | ||
| | `aggregation` | The aggregation type of the Attribute | One of: `counter`, `sum`, `min`, `max`, `mean`, `first`, `last`, `unique_list` | | ||
| | `property_syntax` | The syntax used to reference the property. | One of: `snowflake`, `blobl` | | ||
| | `property` | The property of the event or entity you wish to use in the aggregation | `string` | |
There was a problem hiding this comment.
I think we'll need a bit more documentation on this as there are complexities about the syntax and naming that should be used here.
We decided that we'll use Snowflake syntax for accessing nested properties within events and entities. Also the columns names are the same as in the atomic events table. There was a bit more detail in this doc.
One can also access other properties in the atomic events table like app_id and more. It'd be great to provide some examples.
There was a problem hiding this comment.
I think it deserves a separate paragraph/section as users will definitely need to figure out how to do that.
| @@ -0,0 +1,5 @@ | |||
| { | |||
| "title": "Snowplow Signals CLI Tutorial", | |||
There was a problem hiding this comment.
@ilias1111 can we rename this to Create Batch Attributes using Snowplow Signals?
There was a problem hiding this comment.
Create Batch Attributes using Snowplow Signals But isnt what we are doin, we are creating dbt projects ( batch engine projects ) based on already generated attributes :/ What should we say?
| Before starting, ensure you have: | ||
|
|
||
| - Python 3.11+ installed | ||
| - Snowplow Signals SDK installed |
There was a problem hiding this comment.
Show them how to install this - have a pip install command or something.
Also it's not totally obvious to me that installing a Python package means it can be used as a CLI tool, maybe just clarify that piece.
There was a problem hiding this comment.
This is skipped for now, in the sense that the cli is not live in pypi thus i cannot test the command and there is no point to saying it. Will add it when we are live with the sdk
| - API URL | ||
| - API Key | ||
| - API Key ID | ||
| - Organization ID |
There was a problem hiding this comment.
Tell them how to find all these bits of information - you can copy from the Quickstart guide.
| --api-key "YOUR_API_KEY" \ | ||
| --api-key-id "YOUR_API_KEY_ID" \ | ||
| --org-id "YOUR_ORG_ID" \ | ||
| --repo-path "./my_snowplow_repo" \ |
There was a problem hiding this comment.
You should show a step to create the repo earlier on (mkdir...)
|
|
||
| ## Choosing Between Options | ||
|
|
||
| - Use **Option 1** when you want to set up projects for all your batch views at once |
There was a problem hiding this comment.
I had already forgotten what Option 1 and 2 were here, could you just use their descriptive names?
* Add missing batch content * Updates * Updates on the installation * John changes --------- Co-authored-by: Ilias Xenogiannis <ilias1111@users.noreply.github.com>
* Rename signals to sp_signals * Rename cli tutorial * Remove cli details from batch engine * Add view prerequisite to cli tutorial * Add online offline to view def * Clarify onlne offline matrix * Update docs/signals/views_services/index.md
|
Can someone check this PR against Vale please, haven't finished reviewing yet but seen a few formatting problems |
docs/signals/quickstart/index.md
Outdated
| $ pip install snowplow-signals | ||
| ``` | ||
|
|
||
| To connect to your Signals deployment, you will need 4 values. |
Co-authored-by: Miranda Wilson <miranda@snowplow.io>
Co-authored-by: Miranda Wilson <miranda@snowplow.io>
Co-authored-by: Miranda Wilson <miranda@snowplow.io>
eed7d0d to
5f491c3
Compare
* Move stuff around * Add overview to intro page * Add links * Move paragraph * Update following review
PR #1293 * update architeture diagram * add custom entity docs * add Stream limitations note
No description provided.