riceissa / contractwork

contractwork

This repository contains details of contract work sponsored by Vipul Naik. The repository was officially created as a separate repository on Friday, December 9, 2016, forked from working-drafts.

See the contributor cover summary for more details.

For a usable interface to understand all the contract work so far, see Contract Work for Vipul Naik. The underlying code for that is in the access-portal folder in this Git repository.

If you are a new contributor or contract worker who works on Wikipedia content creation, make sure to read Issa Rice's Memo for Wikipedia editors who are starting.

Setting up

This section is for people who want to set up a local mirror of the contract work portal (e.g., for development purposes) or want to load up the data into a local database to run their own queries.

Note that the passwordFile.inc file in access-portal/backend/globalVariables is excluded from the Git repository, but you can modify a corresponding dummy password file at dummyPasswordFile.inc:

cp access-portal/backend/globalVariables/{dummyPasswordFile.inc,passwordFile.inc}
vi access-portal/backend/globalVariables/passwordFile.inc # change to add database login info

The database name is present both in dummyPasswordFile.inc and in the Makefile, so if you want a name other than contractwork, you should edit the name in both places.

You can create the contractwork database either directly in MySQL or by running this from the root folder of this repository, after updating MYSQL_ARGS in the Makefile (such as -u<username> -p<password>):

make init

Instead of editing the Makefile, you can also pass in the arguments to make:

make MYSQL_ARGS=<args> init

Loading and refreshing data

Once you already have the contractwork SQL database set up, you can update the MYSQL_ARGS in the Makefile (such as -u<username> -p<password>) and you can then load the public portion of the data using:

make reset && make read_public

Instead of editing the Makefile, you can also pass in the arguments to each make:

make MYSQL_ARGS=<args> reset && make MYSQL_ARGS=<args> read_public

If you have access to the private folders (that are not part of this repository) you may replace read_public with read.

Table sorting

To get files for table sorting, run:

make fetch_table_sorting

You can remove these files with make clean_table_sorting.

AnchorJS

To get AnchorJS, run:

make fetch_anchorjs

You can remove these files with make clean_anchorjs.