Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-9107 Added link to the min.js ibexa tracker file. #2522

Merged
merged 10 commits into from
Oct 18, 2024

Conversation

nkostiv
Copy link
Contributor

@nkostiv nkostiv commented Oct 17, 2024

Question Answer
JIRA Ticket https://issues.ibexa.co/browse/IBX-9107
Versions 4.6
Edition

Added link to the ibexa tracker minified javascript file.
Added more details about userId

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR!

Preview: https://ez-systems-developer-documentation--2522.com.readthedocs.build/en/2522/personalization/tracking_with_ibexa-tracker/

I believe people should simply use the minified version and forget about it, right?

I suggest changing the line 44 to cdn.perso.ibexa.co/ibexa-tracker.min.js(as this will actually make them use the minified version).

I would even consider not mentioning the "full" version at all - I don't think it's needed. What do you think?

Comment on lines 25 to 28
`<YOUR_MANDATOR_ID>` with the customer ID, `<PAGE_ID>` with the page/item identifier.
`<USER_ID>` - empty string for cookie based anonymous user or replaced with the value generated
by your user identifier system for logged-in user. In case user activity should not be tracked,
'not_defined' value should be used to still have an event stored without link to the user.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<YOUR_MANDATOR_ID>` with the customer ID, `<PAGE_ID>` with the page/item identifier.
`<USER_ID>` - empty string for cookie based anonymous user or replaced with the value generated
by your user identifier system for logged-in user. In case user activity should not be tracked,
'not_defined' value should be used to still have an event stored without link to the user.
- `<YOUR_MANDATOR_ID>` with the customer ID
- `<CONTENT_TYPE_ID>` with the Content Type ID
- `<CONTENT_ID>` with the content item ID
- `<USER_ID>` with an empty string for cookie based anonymous user or replaced with the value generated by your user identifier system for logged-in user. In case user activity should not be tracked, 'not_defined' value should be used to still have an event stored without a link to the user.
  1. I think a list makes it more readable
  2. The PAGE_ID placeholder doesn't exist anymore, but there's CONTENT_ID and CONTENT_TYPE_ID - can you please check if my suggestion makes sense?
  3. Please also add a : after replace (I cannot add it through GitHub suggsetions)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chaged according to suggestion.
About keep only minified version, I think it will be good for debug purpose to have the original file. It could help partners easy undersdtand how tracking working.

nkostiv and others added 2 commits October 18, 2024 10:55
Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>
Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mnocon mnocon merged commit 7ddffda into master Oct 18, 2024
6 checks passed
@mnocon mnocon deleted the IBX-9107_added_min_js_tracker branch October 18, 2024 12:18
mnocon pushed a commit that referenced this pull request Oct 18, 2024
* IBX-9107 Added link to the min.js ibexa tracker file.

* IBX-9107 Added link to the min.js ibexa tracker file.

* IBX-9107 Added link to the min.js ibexa tracker file.

* IBX-9107 Added more details about user

* IBX-9107 Fixed spaces.

* IBX-9107 Updated not defined user details.

* IBX-9107 Changed after PR comments.

* Update docs/personalization/tracking_with_ibexa-tracker.md

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>

* IBX-9107 Changed url in example

---------

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>
mnocon pushed a commit that referenced this pull request Nov 8, 2024
* IBX-9107 Added link to the min.js ibexa tracker file.

* IBX-9107 Added link to the min.js ibexa tracker file.

* IBX-9107 Added link to the min.js ibexa tracker file.

* IBX-9107 Added more details about user

* IBX-9107 Fixed spaces.

* IBX-9107 Updated not defined user details.

* IBX-9107 Changed after PR comments.

* Update docs/personalization/tracking_with_ibexa-tracker.md

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>

* IBX-9107 Changed url in example

---------

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants