Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: sitescripts/content_blocker_lists/README.md

Issue 29332452: Noissue - Add documentation for content_blocker_lists (Closed)
Patch Set: Created Dec. 8, 2015, 4:01 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sitescripts/content_blocker_lists/README.md
diff --git a/sitescripts/content_blocker_lists/README.md b/sitescripts/content_blocker_lists/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..4d4aee06130b9177b1291491d9ff3e6288aa4e54
--- /dev/null
+++ b/sitescripts/content_blocker_lists/README.md
@@ -0,0 +1,34 @@
+# Content blocker lists
+
+## Introduction
+
+The `sitescripts.content_blocker_lists.bin` package contains scripts
+used on the server side for producing our content blocker lists.
+[Content blocker lists can be used by newer versions of Safari and iOS][1].
+
+## generate_lists.py
+
+The generate_list.py script wraps [ab2blocklist][2] so that we can more
Sebastian Noack 2015/12/09 17:06:25 Typo: ab2blocklist -> abp2blocklist
kzar 2015/12/10 13:09:23 Done.
+conveniently produce our content blocker lists on our servers. The script
+additionally wraps the lists with some metadata [as specified in issue 3176][3].
+
+To use add the relevant configuration to your scritescripts.ini file. For
Sebastian Noack 2015/12/09 17:06:25 Nit: Put filenames in backticks
kzar 2015/12/10 13:09:23 Done.
+example:
+
+ [content_blocker_lists]
+ abp2blocklist_url=https://hg.adblockplus.org/abp2blocklist
+ abp2blocklist_path=%(root)s/content_blocker_lists/abp2blocklist
+ easylist_url=https://easylist-downloads.adblockplus.org/easylist_noadult.txt
+ exceptionrules_url=https://easylist-downloads.adblockplus.org/exceptionrules.txt
+ easylist_content_blocker_path=%(root)s/content_blocker_lists/easylist_content_blocker.json
+ easylist_content_blocker_expires=4 days
+ combined_content_blocker_path=%(root)s/content_blocker_lists/easylist+exceptionrules_content_blocker.json
+ combined_content_blocker_expires=4 days
+
+Then you can run the script as follows:
+
+ python -m sitescripts.content_blocker_lists.bin.generate_lists
+
+[1]: https://webkit.org/blog/3476/content-blockers-first-look/
+[2]: https://hg.adblockplus.org/abp2blocklist/
+[3]: https://issues.adblockplus.org/ticket/3176
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld