Analytics/ReportCard

Report Card
This wiki documents the (so far very manual process) to get the report card data to display at: http://reportcard.wmflabs.org/. Consumers of this document are internal members of analytics team.

Steps
1. Get data files.

2. Clone github repo reportcard data: git clone [ssh://nuria@gerrit.wikimedia.org:29418/analytics/reportcard/data.git ssh://user@gerrit.wikimedia.org:29418/analytics/reportcard/data.git]

3. Execute script that turns source files into limn metadata:

cd old_rc_new

./run.sh 3.1 cd old_rc_new 3.2 ./run.sh

Watch out for a stack trace there, if source files are wrong somehow they would cause a stack trace to display. To debug, you must look at the python files starting probably with deploy.py

4.You need a local instance of limn running 4.1 git clone https://github.com/wikimedia/limn.git 4.2 git checkout develop 4.3 npm install 4.4 add limn/var/config.json to configure Google OAuth, see example below 4.5 npm start

After making sure limn starts, link the processed dataset for the reportcard with your localinstance to make sure it all looks good: Suposing you are on the limn directory and that the reportcard data is at: /workplace/reportcard-data you need to run:

coke --vardir ./var --data /workplace/reportcard-data/ --to rc link_data

5. Clone limn-deploy and install dependencies, including fabric (a python ssh deployer): 5.1 git clone https://github.com/wikimedia/limn-deploy 5.2 cd limn-deploy 5.3 pip install -e. . Deploy to http://test-reportcard.wmflabs.org. The following command does so by ssh-ing into limn0 (configured in fabfile/stages.py) fab test_reportcard deploy.only_data 7. When all looks good, deploy to the real reportcard: http://reportcard.wmflabs.org/ fab prod deploy.only_data