Skip to content

Commit

Permalink
Merge pull request #4 from rtfd/davidfischer/remove-whitelist-term
Browse files Browse the repository at this point in the history
Remove whitelist term
  • Loading branch information
davidfischer committed May 2, 2018
2 parents f509aeb + 59fd7b4 commit d937e13
Show file tree
Hide file tree
Showing 11 changed files with 35 additions and 35 deletions.
14 changes: 7 additions & 7 deletions README.rst
Expand Up @@ -2,26 +2,26 @@ Advertising for Open Source Exception Lists
===========================================

This repository contains filter lists compatible with many ad blockers such
as Adblock, AdblockPlus, and uBlock Origin that whitelists advertising that
as Adblock, AdblockPlus, and uBlock Origin that allows advertising that
directly benefits open source software.

Many open source projects depend on advertising to fund their development
and operations.

There are two whitelists:
There are two lists:

Open Source Ads Whitelist (`view list <https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/opensource-ads.txt>`_)
This list whitelists advertising that directly benefits open source
Open Source Ads (`view list <https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/opensource-ads.txt>`_)
This list allows advertising that directly benefits open source
projects by paying for development, paying for operations, or providing
direct funding. You can `read more`_ for details on the criteria for
inclusion or to get your project included.

Read the Docs Ads Whitelist (`view list <https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/readthedocs-ads.txt>`_)
This list whitelists advertising on Read the Docs. Read the Docs is an
Read the Docs Ads (`view list <https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/readthedocs-ads.txt>`_)
This list allows advertising on Read the Docs. Read the Docs is an
ad-supported website that builds documentation for tens of thousands of
open source projects. Advertising on Read the Docs complies with their
policy of `ethical advertising`_ which takes privacy seriously. This list
is a strict subset of the Open Source Ads Whitelist.
is a strict subset of the Open Source Ads list.

.. _read more: https://ads-for-open-source.readthedocs.io/inclusion.html
.. _ethical advertising: https://docs.readthedocs.io/en/latest/ethical-advertising.html
2 changes: 1 addition & 1 deletion docs/source/_static/lists/.gitkeep
@@ -1 +1 @@
This folder contains generated output of adblock whitelists
This folder contains generated output of adblock lists
2 changes: 1 addition & 1 deletion docs/source/conf.py
Expand Up @@ -24,7 +24,7 @@
BASE_PATH = os.path.dirname(__file__)

generate_lists_script = os.path.join(BASE_PATH, '..', '..', 'generate-lists.py')
print('Generating adblock whitelists...')
print('Generating adblock exception lists...')
subprocess.check_call([
generate_lists_script
])
Expand Down
16 changes: 8 additions & 8 deletions docs/source/developing.rst
@@ -1,12 +1,12 @@
Developing these Whitelists
===========================
Developing these lists
======================


Generate these docs
-------------------

This is the command to generate the documentation you are reading now.
The first step of generating the docs is to generate the whitelists so they
The first step of generating the docs is to generate the lists so they
are included in the docs build output.

::
Expand All @@ -15,18 +15,18 @@ are included in the docs build output.
% cd docs && make html


Generate the whitelists
-----------------------
Generate the lists
------------------

To generate the whitelists only locally, you can run the following:
To generate the lists only locally, you can run the following:

::

% pip install -r requirements.txt
% ./generate-lists.py # output written to docs/source_static/lists/


Writing whitelist filters
-------------------------
Writing list filters
--------------------

See the `AdblockPlus documentation on writing filters <https://adblockplus.org/en/filters>`_.
8 changes: 4 additions & 4 deletions docs/source/faq.rst
Expand Up @@ -16,18 +16,18 @@ My adblocker allows acceptable ads. Do I still need this?
Read the Docs identified multiple projects where ads were blocked and those
projects lacked the time and resources to work with the
`AcceptableAds group`_ or educate users about the impact of adblocking on
their funding. These whitelists are specifically to help these projects.
These whitelists are not a strict subset of the acceptable ads list.
their funding. These lists are specifically to help these projects.
These lists are not a strict subset of the acceptable ads list.

Furthermore, some users don't want to allow acceptable ads while they are
willing to tolerate ads to benefit the developer community.

.. _AcceptableAds group: https://acceptableads.com/

I run an open source project. How do I get on the whitelist?
I run an open source project. How do I get on the list?
Please see the page on :doc:`getting included <inclusion>`.

How do I report an ad that shouldn't be whitelisted?
How do I report an ad that shouldn't be excepted?
Please open an `issue on GitHub`_.

.. _issue on GitHub: https://github.com/rtfd/ads-for-opensource/issues
Expand Down
6 changes: 3 additions & 3 deletions docs/source/inclusion.rst
@@ -1,7 +1,7 @@
Getting Included on the Whitelist
=================================
Getting Included on the list
============================

To get included on the **Open Source Ads Whitelist**, please verify that the
To get included on the **Open Source Ads** list, please verify that the
advertising meets all of the criteria below and then open an `issue on GitHub`_
with the following information:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Expand Up @@ -10,6 +10,6 @@
faq
developing

.. note:: These whitelists are a service of `Read the Docs`_.
.. note:: These lists are a service of `Read the Docs`_.

.. _Read the Docs: https://readthedocs.org
12 changes: 6 additions & 6 deletions docs/source/installation.rst
@@ -1,7 +1,7 @@
Installing Adblock Filter Lists
===============================

Adblock lists, whether filters that block additional items or whitelist
Adblock lists, whether filters that block additional items or allow
exceptions like the ones here, can be installed on every major
adblocker. Here are the installation steps on the three biggest adblockers.

Expand All @@ -19,14 +19,14 @@ Installing on AdblockPlus
The easiest way to install these lists on AdblockPlus is to use AdblockPlus'
URL listener for subscribing to new lists:

* Click this link for the `Open Source Ads Whitelist`_
* Click this link for the `Open Source Ads`_
and confirm by hitting the "Yes, use this filter list" button
* Or click this link for the `Read the Docs Ads Whitelist`_
(a subset of the first list that only whitelists Read the Docs)
* Or click this link for the `Read the Docs Ads`_
(a subset of the first list that only allows ads on Read the Docs)
and confirm by hitting the "Yes, use this filter list" button

.. _Open Source Ads Whitelist: abp:subscribe?location=https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/opensource-ads.txt&title=Open%20Source%20Ads%20Whitelist
.. _Read the Docs Ads Whitelist: abp:subscribe?location=https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/readthedocs-ads.txt&title=Read%20the%20Docs%20Ads%20Whitelist
.. _Open Source Ads: abp:subscribe?location=https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/opensource-ads.txt&title=Open%20Source%20Ads%20Exceptions
.. _Read the Docs Ads: abp:subscribe?location=https://ads-for-open-source.readthedocs.io/en/latest/_static/lists/readthedocs-ads.txt&title=Read%20the%20Docs%20Ads%20Exceptions

Alternatively, adding filter lists on AdblockPlus can be done in just a few steps:

Expand Down
4 changes: 2 additions & 2 deletions generate-lists.py
@@ -1,6 +1,6 @@
#!/usr/bin/env python

"""Generates adblock whitelists based on templates in ``list-templates``."""
"""Generates adblock exception lists based on templates in ``list-templates``."""

import os
import subprocess
Expand All @@ -27,4 +27,4 @@
infile,
outfile,
])
print(u'- Wrote whitelist to {}'.format(outfile))
print(u'- Wrote list to {}'.format(outfile))
2 changes: 1 addition & 1 deletion list-templates/opensource-ads.template
Expand Up @@ -3,7 +3,7 @@
! Last modified: %timestamp%
! Expires: 1 days (update frequency)
!
! Whitelists advertising that directly supports open source software.
! Allows advertising that directly supports open source software.
!
! Homepage: http://ads-for-open-source.readthedocs.io/
! Issues: https://github.com/rtfd/ads-for-opensource/issues
Expand Down
2 changes: 1 addition & 1 deletion list-templates/readthedocs-ads.template
Expand Up @@ -3,7 +3,7 @@
! Last modified: %timestamp%
! Expires: 1 days (update frequency)
!
! Whitelists advertising on Read the Docs.
! Allows advertising on Read the Docs.
!
! Read the Docs is an ad-supported, open source project that builds
! and hosts docs for tens of thousands of open source projects.
Expand Down

0 comments on commit d937e13

Please sign in to comment.