Grants:IEG/Mediawiki extension for Community Metrics

From Meta, a Wikimedia project coordination wiki

status: ineligible

Individual Engagement Grants
Individual Engagement Grants
Review grant submissions
review
grant submissions
Visit IdeaLab submissions
visit
IdeaLab submissions
eligibility and selection criteria

project:

Mediawiki extension for Community Metrics


project contact:

acs@bitergia.com

participants:




summary:

Mediawiki extension to integrate Community Metrics in Mediawiki

engagement target:

MediaWiki

strategic priority:

Infrastructure, Improving Quality

total amount requested:

27500€


2014 round 1

Project idea[edit]

The MediaWiki project, as corresponds to a mature and widely used free / open source software project, has reached a high level of complexity. This complexity can be found not only in the structure and details of the source code, but in almost any aspect of the projects.

In order to manage the complexity of MediaWiki development a dashboard has being developed and it provides many time series metrics about the community, and different aspects of the product and processes. Among them, the following are included: number of commits, committers, authors from the source code management system, open and closed tickets, parameters related to time-to-attend and time-to-fix tickets, active developers in the source code, or different people writing in the forums. For a full list of basic pieces of information found in the repositories, please refer to the annex “Basic Pieces of Information found in Main Data Sources“.

This dashboard currently is a combination of HTML, CSS and Javascript (JS), with all the data fetched from JSON files using JS.

In this proposal the idea is to use Mediawiki to layout the Development Community Metrics dashboard. All the visualizations in the dashboard are created using the VizGrimoireJS (VizJS) markup API.

This VizJS API will be available in Mediawiki so dashboards could be created easily using Mediawiki as the main engine.

Project goals[edit]

The final goal is that Mediawiki will be used as a reference platform in order to create dashboards for software projects analysis.

As a use case Wikimedia Community Metrics portal at http://korma.wmflabs.org/ will be migrated to Mediawiki portal. Also, other projects using VizGrimoireJS as their platform for Community metrics could also Mediawiki as the portal engine (for example http://activity.openstack.org/dash/browser/).

Project plan[edit]

Scope:[edit]

Scope and activities[edit]

Develop a MediaWiki extension in order to use VizGrimoireJS API for creating Development Community Metrics Dashboards.

Main activities:

  • Integrate VizJS Javascript libraries
  • Integrate VizJS CSS
  • Define the process to include the new divs in Mediawiki pages
  • Integrate VizJS browser in Mediawiki
  • Integrate VizJS dashboard in Mediawiki
  • Create a Mediawiki theme using Bootstrap CSS technology
  • Migrate http://korma.wmflabs.org/browser/ to a Mediawiki based portal
  • First steps in the community development around this extensions, and dissemination.


Tools, technologies, and techniques[edit]

The work will be done using MediaWiki and web technologies, mainly HTML, CSS and Javascript.

Budget:[edit]

Total amount requested[edit]

Total budget: 27500€

Budget breakdown[edit]

Using the activities defined, the budget for each of them are:

  • Create a Mediawiki extension for using VizGrimoireJS API: 10000€ (2.5 weeks)
    • Complete all requeriments
    • Build a first prototype
    • Convert all to a Mediawiki extension
    • Testing for all VizGrimoireJS API
    • Release Mediawiki extension
  • Create VizGrimoireJS Browser and Dashboard using MediaWiki: 10000€ (2.5 weeks)
    • Create MediaWiki Bootstrap Theme
    • Develop Browser and Dashboard
  • Migrate http://korma.wmflabs.org/browser/ to a Mediawiki based portal: 5000€ (1 week)
  • First steps in the community development around this extensions, and dissemination: 2500€

Intended impact:[edit]

Target audience[edit]

Development Community Metrics is an emerging topic in Software Projects and specially, in Open Source projects. Using Mediawiki as the basis for building Community Metrics dashboards will extend the adoption of MediaWiki to new projects, and specially, to Open Source projects. MediaWiki+VizGrimoire will be a powerful combination for offering a solid and complete Community Metrics platform.


Fit with strategy (Pending)[edit]

  • Increasing Reach
  • Increasing Quality in MediaWiki development, and in general, in Open Source project development.
  • Improve transparency and visibility in Open Source development
  • Improve participation in MediaWiki development community

Sustainability[edit]

  • Wikimedia has an Analytics group that can help in the Sustainability of this extension
  • First steps in Community creation will be done during the project
  • The Community around MetricsGrimoire and VizGrimoire projects will use this extension for building dashboards.
  • Other projects using VizGrimoire like OpenStack could adopt this MediaWiki based Dashboard: http://activity.openstack.org/dash/browser/

Measures of success[edit]

  • A MediaWiki extension will be released
  • WikiMedia Community Metrics dashboard will be converted using the new created extension

Participant(s)[edit]

Discussion[edit]

Community Notification:[edit]

Please paste a link to where the relevant communities have been notified of this proposal, and to any other relevant community discussions, here.

Endorsements:[edit]

Do you think this project should be selected for an Individual Engagement Grant? Please add your name and rationale for endorsing this project in the list below. Other feedback, questions or concerns from community members are also highly valued, but please post them on the talk page of this proposal.

  • Community member: add your name and rationale here.