IBX-11100: Hybrid tracking described in Dev-doc#3250
Conversation
Preview of modified filesPreview of modified Markdown: |
mnocon
left a comment
mnocon
left a comment
There was a problem hiding this comment.
Hybrid tracking must be mentioned in other places, it's not enough to describe it just in a separate article - right now it feels disconnected from other parts of the doc.
Examples:
tracking_type: hybrid must be mentioned, in the YAML and in the list
hybrid_tracking_proxy_path should be mentioned in the global configuration reference?
The function output must be expanded to mention the hybrid type
|
|
||
| When hybrid tracking is enabled, `TrackingScriptExtension` renders the proxy bootstrap template and loads the `raptor-proxy.js` shim, which replaces the `window.raptor.push` and drains the initial event queue. | ||
| The shim sends events to the configured proxy endpoint, by default, `/raptor/track`. | ||
| Each event is sent in a separate request using a batch-compatible format. |
There was a problem hiding this comment.
I'm not sure what it means. What's a batch-compatible format and why is it important to mention?
| ### Template usage | ||
|
|
||
| By default, the tracking script waits for user consent before sending tracking events. | ||
| Consent can be provided either by rendering the script with `ibexa_tracking_script` (`has_consented` = `true`) or by triggering the `enableTracking` JavaScript event. |
There was a problem hiding this comment.
I feel this part is repeated in https://ez-systems-developer-documentation--3250.com.readthedocs.build/en/3250/templating/twig_function_reference/recommendations_twig_functions/#ibexa_tracking_script-function:~:text=needed%2E-,If,consent,-%2E , but here it's less detailed, doesn't mention enableTracking and doesn't show an example.
Can we just say something like:
By default, the tracking script waits for user consent before sending tracking events. For more info, see https://ez-systems-developer-documentation--3250.com.readthedocs.build/en/3250/templating/twig_function_reference/recommendations_twig_functions/#ibexa_tracking_script-function
And maybe in recommendations_twig_functions add a new subsection called "Handle tracking consent" for easier linking between sections?
There was a problem hiding this comment.
Agreed — no point duplicating it here, especially since this version is less complete (no enableTracking, no example). Shortening it to a one-line note plus a link to ibexa_tracking_script makes sense, and adding a "Handle tracking consent" subsection there for easy linking is a good idea.
3 participants
Hybrid tracking described in Dev-doc
Checklist