Github mirror of "wikimedia/discovery/dashboard" - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cache/apt
files
log
shiny-server
.gitignore
.gitmodules
.gitreview
CHANGELOG.md
CONDUCT.md
Makefile
README.md
Vagrantfile
setup.sh

README.md

Discovery Dashboards

Deprecation Notice: This repository is no longer in use because we have switched to a Puppet-based solution per T161354. In order to maintain a historical record, it has not been deleted. If you are interested in seeing how this repo looks translated into Puppet, see discovery_dashboards::base, discovery_dashboards::production, and shiny_server module.

This is a collection of dashboards and tools for exploring aggregated Wikimedia Search Platform and Wikimedia Discovery data. It contains everything from API usage to direct user interactions, and will only grow over time. The idea is that this will provide data for internal use and external use, to see how well we're doing.

Running in Labs

Go to Special:NovaInstance on wikitech and start a new instance. The small instance with 2GB of memory is sufficient. Choose the image 'ubuntu-14.04-trusty' and click go. Wait for the instance to start, then login via SSH.

Follow the instructions for setting up your instance with MediaWiki-Vagrant. Specifically, add "role::labs::vagrant_lxc" and run sudo puppet agent --test --verbose

Log out and log back in.

sudo git clone https://gerrit.wikimedia.org/r/wikimedia/discovery/dashboard /srv/dashboards
cd /srv/dashboards
sudo git submodule update --init --recursive
sudo vagrant up
sudo chown -R mwvagrant .vagrant
vagrant up

shiny-server should now be running on port 3838. To make this available to the world visit Special:NovaProxy in wikitech. Point a subdomain at the instance and make sure to port 3838 as the instance port.

Updating

Perform this step after merging a patch:

sudo make update

Manually restarting Shiny Server

$> mwvagrant ssh
ssh> sudo service shiny-server restart

Running on your machine

Download and install Vagrant & VirtualBox. Then clone the repo, initialize the submodules, and vagrant up

Dashboards as submodules

All of the following is done on your local clone of this repo:

Adding

git submodule add <URL to repo>.git shiny-server/<name>
git submodule update --init --recursive

Updating the dashboards in this repository

This repository contains only the code that wraps around and provisions the dashboards, not the dashboard itself. The dashboards are kept as git submodules. To point the submodules at the latest versions, use the following command:

git submodule foreach git pull origin master

Please remember to describe the changes in CHANGELOG.md, then:

git add -A
git commit -m "Updating dashboards..."
git review
<git add -A && git commit --amend && git review>

Additional information

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Maintainers