Do Not Track support #4046
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,33 +2,40 @@ | |
| // https://docs.readthedocs.io/en/latest/advertising-details.html#analytics | ||
|
|
||
|
|
||
| // Skip analytics for users with Do Not Track enabled | ||
|
There was a problem hiding this comment. you can use something like this script to check if There was a problem hiding this comment. That entire script is basically to handle an IE10 bug. I'm not sure it's worth the effort. There was a problem hiding this comment. I think it should be in a script or a function that we can call from any scipt. Regarding IE, we may still support IE10. There was a problem hiding this comment. IE10 is not supported by Microsoft with a couple exceptions and it is a tiny fraction of our users (sub-0.1%). I don't think it is unreasonable to not support a privacy feature for users who are using a browser unsupported by the vendor. In addition, the "support" that the linked script offers is mostly just to mark IE10 as "unspecified" for DNT which for our purpose would be off. I lean toward simplicity here. There was a problem hiding this comment. Understand. then we can keep There was a problem hiding this comment. Actually, after testing this I'm reconsidering. It looks like IE11 on Windows 7 and Windows 8 set the DNT default to on. There was a problem hiding this comment. Considering that to use this script would mean marking IE11 and IE10 as having DNT as "unspecified" I'm leaning toward maybe just checking There was a problem hiding this comment.
Not very easily actually. There was a problem hiding this comment. I updated the PR to just check |
||
| if (navigator.doNotTrack === '1') { | ||
|
There was a problem hiding this comment. Should the JS respect the setting as well? Probably needs to be added to the context manager. There was a problem hiding this comment. I don't understand this comment. Can you elaborate? There was a problem hiding this comment. We shouldn't add this JS opt out unless the DO_NOT_TRACK_ENABLED setting is True There was a problem hiding this comment. Ideally, yes we want to only respect DNT if people running RTD have the setting enabled. However, the use case we are supporting by changing that is to help people taking the readthedocs.org code base and don't want to support DNT. To do this, we would need to pass the DNT setting through the There was a problem hiding this comment. Yea, that makes sense for user docs. I guess I was thinking for the There was a problem hiding this comment. I think that's the only tidbit I'd add before it's deployable -- just so that all our users dashboards don't get DNT'd automatically. There was a problem hiding this comment. I'm going to add this to |
||
| console.log('Respecting DNT with respect to analytics...'); | ||
| } else { | ||
| // RTD Analytics Code | ||
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | ||
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | ||
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | ||
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); | ||
|
|
||
| if (typeof READTHEDOCS_DATA !== 'undefined') { | ||
| if (READTHEDOCS_DATA.global_analytics_code) { | ||
| ga('create', READTHEDOCS_DATA.global_analytics_code, 'auto', 'rtfd', { | ||
| 'cookieExpires': 30 * 24 * 60 * 60 | ||
| }); | ||
| ga('rtfd.set', 'dimension1', READTHEDOCS_DATA.project); | ||
| ga('rtfd.set', 'dimension2', READTHEDOCS_DATA.version); | ||
| ga('rtfd.set', 'dimension3', READTHEDOCS_DATA.language); | ||
| ga('rtfd.set', 'dimension4', READTHEDOCS_DATA.theme); | ||
| ga('rtfd.set', 'dimension5', READTHEDOCS_DATA.programming_language); | ||
| ga('rtfd.set', 'dimension6', READTHEDOCS_DATA.builder); | ||
| ga('rtfd.set', 'anonymizeIp', true); | ||
| ga('rtfd.send', 'pageview'); | ||
| } | ||
|
|
||
| // User Analytics Code | ||
| if (READTHEDOCS_DATA.user_analytics_code) { | ||
| ga('create', READTHEDOCS_DATA.user_analytics_code, 'auto', 'user', { | ||
| 'cookieExpires': 30 * 24 * 60 * 60 | ||
| }); | ||
| ga('user.set', 'anonymizeIp', true); | ||
| ga('user.send', 'pageview'); | ||
| } | ||
| // End User Analytics Code | ||
| } | ||
| // end RTD Analytics Code | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure this is the right part of the docs for this. It feels like it should probably be it's own thing, since it applies to RTD itself, and not just ads.
I realize there are ad-specific things, so maybe a DNT page in the docs, and then also a section here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps having it in the Privacy Policy is enough as an additional section. I guess it depends how heavily we want to promote the fact that we support it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a section in the privacy policy is good and the advertising details will link there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍