Rework destinations intro documentation #9894
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
daniloc
changed the title
Co-authored-by: Ben White <[email protected]>
Co-authored-by: Ben White <[email protected]>
Co-authored-by: Ben White <[email protected]>
Co-authored-by: Ben White <[email protected]>
…stHog/posthog.com into rewrite-cdp-destination-intro
|
|
||
| [Learn more about this in advanced usage](/docs/cdp/advanced). | ||
|
|
||
| ## Caveats |
There was a problem hiding this comment.
I still think this should go in the FAQ
There was a problem hiding this comment.
So I debated that in my mind quite a bit as well, here is my argument for keeping it here:
I think these are more gotchas than they are FAQs, so I want to be upfront instead of burying them. If someone trips up based on one of these issues, I don't want them to assume that the feature is broken and give up on it.
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
…stHog/posthog.com into rewrite-cdp-destination-intro
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
Co-authored-by: Ian Vanagas <[email protected]>
|
Thanks for the thorough eye, gang. I think we're in a good spot but @oliverb123 you've been instrumental here so I'll leave it open in case there's anything to add when you swing through in the morning. |
| ``` | ||
| {event.event} was triggered by {person.properties.first_name} {person.properties.last_name} | ||
|
|
||
| // Outputs: $pageview was triggered by Max the Hedgehog |
There was a problem hiding this comment.
Love this. It's a great example. 👏
|
|
||
| For most cases, we recommend using one of the templates. These take care of most logic under the hood, exposing simple inputs for you to configure. | ||
|
|
||
| You can, however, modify any destination by clicking `show source code`. From here you can modify the inputs – for example marking an input as secret so that it is encrypted as rest – or changing the implementation of the destination itself. |
There was a problem hiding this comment.
I think we use bold for buttons, so maybe this should be **show source code** (instead of using backticks)?
I might be looking at the wrong part of the interface but is the button text actually "Edit source code"?
|
|
||
| ## Testing | ||
|
|
||
| The hardest part of integrating two services is making sure everything works as you expect. Every destination includes a built-in testing interface, enabling you to send real data from PostHog on-demand to your target service and debug any errors. |
There was a problem hiding this comment.
Truly. The DX for destinations is just fucking EXQUISITE, as good as it gets.
Co-authored-by: Bijan Boustani <[email protected]>
Co-authored-by: Bijan Boustani <[email protected]>
Co-authored-by: Ben White <[email protected]>
Changes
Our description of destinations gets immediately into the weeds, failing to quickly convey the power of what we're offering. More than that, it doesn't help a new user set up a new templated destination, the most common use case.
Addresses #9866, #9865, and #9885 by rewriting the destinations intro and adding a reworked advanced usage guide based on the original destination docs.
Checklist