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

Add a page detailing ad blocking #4244

Merged
merged 2 commits into from Jun 18, 2018
Merged

Conversation

@davidfischer
Copy link
Contributor

@davidfischer davidfischer commented Jun 14, 2018

  • Creates a good page for the ad block nag to link to
  • Document about going ad-free
  • Some advertisers have asked about this
  • Stats on ad blocking are interesting - we should publish ours

Important

This moves the ethical-advertising.rst and advertising-details.rst documents into an advertising/ folder. After merging this, we should setup redirects.

- Creates a good page for the ad block nag to link to
- Document about going ad-free
- Some advertisers have asked about this
- Stats on ad blocking are interesting - we should publish ours
@davidfischer davidfischer requested a review from ericholscher Jun 14, 2018
Copy link
Member

@ericholscher ericholscher left a comment

Generally 👍 with a few nits on RST syntax & marketing wording. I think we should really nail how we feel about "subscribing" or "supporting" us, instead of "donating".

Loading

Advertising is the single largest source of funding for Read the Docs.
To keep our operations sustainable, we ask that you either
:ref:`allow our Ethical Ads <advertising/ad-blocking:Allowing Ethical Ads>`
or :ref:`go ad-free <advertising/ad-blocking:Going ad-free>` by donating.
Copy link
Member

@ericholscher ericholscher Jun 15, 2018

Choose a reason for hiding this comment

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

I dislike using the word donate, since they are getting value from their money in not seeing ads. I'd like to come up with better verbiage here; perhaps "by becoming a contributing member" or "supporting member" or something like that.

Loading

Copy link
Contributor Author

@davidfischer davidfischer Jun 15, 2018

Choose a reason for hiding this comment

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

Since we call them "supporters" in the database and in the site footer, let's use the phrase "becoming a supporter". Since we call Gold "becoming a gold member" I don't want to have to differentiate between a "Gold Member" and a "Supporting Member" or a "Contributing Member".

Let's just use "Gold Member" and "Supporter".

Loading

@@ -121,7 +121,7 @@ Analytics

Analytics are a sensitive enough issue that they require their own section.
In the spirit of full transparency, Read the Docs uses Google Analytics (GA).
We go into a bit of detail on our use of GA in our :doc:`privacy-policy`.
We go into a bit of detail on our use of GA in our :doc:`../privacy-policy`.
Copy link
Member

@ericholscher ericholscher Jun 15, 2018

Choose a reason for hiding this comment

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

We should use a absolute link so this doesn't break in the future /privacy-policy

Loading

.. Updated: June 2018
- Serve over **35 million pages** of documentation a month
- Serve over **2 TB** of documentation a month
Copy link
Member

@ericholscher ericholscher Jun 15, 2018

Choose a reason for hiding this comment

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

This number is much higher. We did 40TB last month.

Loading

- Use "supporter" instead of donate
- Use absolute links
- 2TB -> 40TB
@davidfischer
Copy link
Contributor Author

@davidfischer davidfischer commented Jun 15, 2018

I made the suggested changes.

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Jun 18, 2018

Looks great!

Loading

@davidfischer davidfischer merged commit 9a4c459 into master Jun 18, 2018
1 check passed
Loading
@davidfischer
Copy link
Contributor Author

@davidfischer davidfischer commented Jun 18, 2018

Merged, built and the redirects were added.

Loading

marcelstoer
Copy link
Contributor

marcelstoer commented on f409a61 Jun 30, 2018

Choose a reason for hiding this comment

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

I don't understand this, sorry. Doesn't the list at https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/opensource-ads.txt just whitelist readthedocs.io and readthedocs.org (apart from the Mozilla stuff)? What are those other "different domains"?

Loading

davidfischer
Copy link
Contributor

davidfischer commented on f409a61 Jun 30, 2018

Choose a reason for hiding this comment

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

Read the Docs hosts documentation on 2500 domains that aren't *.readthedocs.io.

Loading

davidfischer
Copy link
Contributor

davidfischer commented on f409a61 Jun 30, 2018

Choose a reason for hiding this comment

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

Loading

davidfischer
Copy link
Contributor

davidfischer commented on f409a61 Jun 30, 2018

Choose a reason for hiding this comment

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

I guess perhaps the part that is harder to understand is that if you click "allow" in your ad blocker, it will only allow ads on a specific domain as opposed to all of Read the Docs. Furthermore there are both cosmetic (CSS) block filters that just hide elements as well as URL regexes that block API calls (eg. Our ads API call at https://readthedocs.org/API/v2) and both need to be allowed.

Here's a concrete example: let's say you are browsing docs.example.org a docs site hosted by RTD. An ad blocker subscribed to the easylist will block the ads API call. If you allow it in your ad blocker and later visit docs.anotherexample.org, the API call will still be blocked there.

By installing the list, Read the Docs ads are allowed on all Read the Docs domains.

Loading

marcelstoer
Copy link
Contributor

marcelstoer commented on f409a61 Jun 30, 2018

Choose a reason for hiding this comment

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

The hint about the API is what I needed. I know how those black- and whitelists work and I had already manually whitelisted readthedocs.io and readthedocs.org. However, when I read about "...hosted on many different domains" I was expecting your opensource-ads.txt and readthedocs-ads.txt to list all of those. Not know how exactly you inject the ads I didn't know that all the CNAMEed domains didn't necessarily need to be whitelisted. Thanks for the patience.

Loading

davidfischer
Copy link
Contributor

davidfischer commented on f409a61 Jul 1, 2018

Choose a reason for hiding this comment

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

In theory we could get blocked via CSS filters on other domains but so far I haven't seen that.

Loading

@stsewd stsewd deleted the davidfischer/ad-blocking-details-docs branch Aug 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants