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

Delta Between Two Patch Sets: sitescripts/urlfixer/README.md

Issue 8483155: Added typo data collection (/submitData) (Closed)
Left Patch Set: Created Oct. 9, 2012, 10:58 a.m.
Right Patch Set: Created Oct. 9, 2012, 2:27 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « no previous file | sitescripts/urlfixer/__init__.py » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
1 urlfixer 1 urlfixer
2 ======== 2 ========
3 3
4 Backend for the URL Fixer data collection. It provides the following URLs: 4 Backend for the URL Fixer data collection. It provides the following URLs:
5 5
6 * */submitData* - Receive data from URL Fixer extension 6 * */submitData* - Receive data from URL Fixer extension
7 7
8 Required packages 8 Required packages
9 ----------------- 9 -----------------
10 10
11 * [simplejson](http://pypi.python.org/pypi/simplejson/) 11 * [simplejson](http://pypi.python.org/pypi/simplejson/)
12 12
13 Database setup 13 Database setup
14 -------------- 14 --------------
15 15
16 Just execute the statements in _schema.sql_. 16 Just execute the statements in _schema.sql_.
17 17
18 Configuration
19 -------------
20
21 Add an _urlfixer_ section to _/etc/sitescripts_ or _.sitescripts_ and configure the following keys:
22
23 * _database_
24 * _dbuser_
25 * _dbpassword_
26
18 Data transfer format 27 Data transfer format
19 ---------------------------- 28 ----------------------------
20 29
21 A domain transfered to the server can have one of the following status: 30 A domain transfered to the server can have one of the following types:
Wladimir Palant 2012/10/09 11:51:14 "Status" doesn't seem to be the right word, should
Thomas Greiner 2012/10/09 13:47:02 I tried to avoid calling them "types" due to possi
22 31
23 * 1: the domain was entered 32 * 1: the domain was entered without any further action
Wladimir Palant 2012/10/09 11:51:14 Better: "was entered without any further action" -
24 * 2: there was a typo 33 * 2: the domain was recognized as a typo
Wladimir Palant 2012/10/09 11:51:14 Where and what does it have to do with the domain?
25 * 3: the domain has been corrected 34 * 3: the domain is a correction that the user accepted
Wladimir Palant 2012/10/09 11:51:14 No, this domain *is* the correction. Meaning: "the
26 * 4: false positive (domain was corrected even though the typed domain was no ty po) 35 * 4: the domain is a correction that the user declined
Wladimir Palant 2012/10/09 11:51:14 Better explanation: "user declined our correction"
27 36
28 The server expects the list to be transfered as a JSON object in no particular o rder. Here is an example: 37 The server expects the list to be transfered as a JSON object in no particular o rder. Here is an example:
29 38
30 ```js 39 ```js
31 { 40 {
32 "urlfixer.org": 1, 41 "urlfixer.org": 1,
33 "adblockplus,org": 2, 42 "adblockplus,org": 2,
34 "adblockplus.org": 3, 43 "adblockplus.org": 3,
35 "goggle.com": 1, 44 "goggle.com": 1,
36 "google.com": 4 45 "google.com": 4
37 } 46 }
38 ``` 47 ```
LEFTRIGHT

Powered by Google App Engine
This is Rietveld