Show an adblock admonition in the dev console #3894
Conversation
|
To test this locally, change |
| console.error('Error loading Read the Docs promo'); | ||
|
|
||
| if (xhr && xhr.status === 404 && rtd.api_host === 'https://readthedocs.org') { |
There was a problem hiding this comment.
Feel like we probably need more of a check here. Is there an error thrown when it's blocked? In chrome I see "Blocked by the client" -- is there a specific error we should be looking for that is similar?
There was a problem hiding this comment.
From jQuery's perspective, it is just a 404.
|
I don't think this will do anything with respect to getting people to whitelist us. However, it illustrates how to detect an ad blocker and simply logs to the console (which might alert us to any false positives) before we take any further action. |
| console.log(' - only show advertisements of interest to developers'); | ||
| console.log('You can read more about our approach to advertising here: https://docs.readthedocs.io/en/latest/ethical-advertising.html'); | ||
|
|
||
| console.log('%cPlease whitelist *.readthedocs.io on your adblocker!', 'font-size: 2em'); |
There was a problem hiding this comment.
I think we need to say *.readthedocs.org maybe?
Look at this
There was a problem hiding this comment.
That's a good catch. I need to review this. We may need both...
There was a problem hiding this comment.
This is a larger problem than I thought.
Whitelisting *.readthedocs.io is all that is necessary (on AdblockPlus at least) to allow Read the Docs ads on all of our sites hosted on a subdomain. However, ads will continue to be blocked on any custom domains where we host ads. Whitelisting readthedocs.org does not change this. This makes simple whitelisting impossible across all ~10,000 domains where we host ads.
There was a problem hiding this comment.
After reviewing their filter syntax, we need the following two filters:
@@||readthedocs.org/*(exception for making an ad request)@@readthedocs.io^$document(exception for hiding elements)
|
I noted the specific commands needed to whitelist across our custom domains. |
This PR shows an adblock admonition in the browser developer console. While I don't think this will convert many hearts and minds, I believe it is a good first step.