Difference between revisions of "Activity Board"
(Initial skeleton for the activity board wiki page) |
(→Toolset) |
||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
=== Mission === | === Mission === | ||
| − | + | The goal of the Activity Board project is to provide a dashboard of software development activity metrics of the OpenStack community. | |
| + | |||
=== Description === | === Description === | ||
| − | + | The current version of the Activity Board project only contains the web front-end needed to navigate through the several perspectives of the OpenStack software development process. This is based on the analysis of the repositories of information used by the community as basic infrastructure: versioning system, issue tracking system, mailing lists and others. | |
| + | |||
| + | The outcomes of this project can be divided into two main groups: | ||
| + | * '''Open data''': OpenStack software repositories are publicly available. And such repositories contain loads of dataset about how the OpenStack community behaves and evolves through time. The Activity Board project aims at providing such raw data in a more human-readable format and aggregated in databases and other formats. | ||
| + | * '''Metrics browser''': this product visualizes that parsed open data and provides specific visualizations. Indeed, the proposed visualization can be easily extensible by the community and third parties. Given its extensibility, in the current version of the Activity Board, there are three main frontends: General Overview of the activity, releases study and actionable dashboard. | ||
| + | |||
| + | ===Deployed Studies=== | ||
| + | Current version of the Activity Board provides several faces of the OpenStack project: Development Activity Browser, Releases and Companies study, and Actionable dashboard. Each of this parts of the Activity Board was built with a specific goal. | ||
| + | |||
| + | ====Development Activity Browser==== | ||
| + | [http://activity.openstack.org/dash/ The Development Activity Browser] aims at providing a common place for those interested in the OpenStack Foundation development activity. This provides detailed information about each of the data sources analyzed (Gits, Launchpad, Gerrit and Mailing lists), stressing the point of the community and its evolution. | ||
| + | |||
| + | The list of projects are based on those that appear in the [https://wiki.openstack.org/wiki/Programs OpenStack Foundation Programs]. | ||
| + | |||
| + | ====Releases and Companies Browser==== | ||
| + | [http://activity.openstack.org/dash/releases The Releases and Companies Browser] provides an analysis of the community with special emphasis in the companies participating in each release and their developers. | ||
| + | |||
| + | This browser allows to understand how the evolution of the main companies took place during specific releases (even during the whole history of the project). In addition it is possible to navigate through the several data sources analyzed and even at the level of providing information per company. | ||
| + | |||
| + | ====Actionable Dashboard==== | ||
| + | [http://activity.openstack.org/dash/newbrowser/dashboard/ The Actionable Dashboard] is probably the most powerful of the three analysis. Indeed this allows the user to create charts from scratch selecting among metrics, companies, projects and dates (releases and years). | ||
| + | |||
| + | |||
=== Toolset === | === Toolset === | ||
| − | + | The Activity Board consists of three steps: | |
| − | + | * Retrieval process | |
| − | + | * Filtering and parsing process | |
| − | ==== | + | * Visualization |
| − | + | ||
| − | ==== | + | [[File:Grimoire-arch.png|thumbnail|High level architecture]] |
| − | + | ||
| − | + | ==== Retrieval ==== | |
| − | + | Information is parsed from software development repositories and stored in MySQL databases. Software development repositories are any type of data source with activity of interest for developers and the OpenStack community in general. Examples of this type of data sources are the versioning systems such as Git, mailing lists for discussions, the Launchpad ticketing system or the Gerrit activity. | |
| − | === | + | |
| − | + | The data mining toolset is based on the [http://metricsgrimoire.github.io/ Metrics Grimoire project] that provides specific tools for each of the analyzable information data sources. | |
| + | |||
| + | ==== Visualization ==== | ||
| + | The final part of this process consists of the visualization, where those JSON files are feeded to the [https://github.com/VizGrimoire/VizGrimoireJS-lib VizGrimoireJS] library, that builds the web frontend necessary to navigate through the several aspects of the OpenStack project. | ||
| + | |||
| + | === How to contribute === | ||
| + | This projects follows the general software development process of the OpenStack project. A bit more of information can be found in the [http://docs.openstack.org/infra/manual/developers.html Developer's Guide]. | ||
| + | |||
| + | Besides, you can collaborate with the project using the following channels: | ||
| + | * Git repository: http://git.openstack.org/cgit/openstack-infra/activity-board/ | ||
| + | * [https://launchpad.net/openstack-community Launchpad OpenStack Community project] using the tag ''activityboard'' | ||
| + | * [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev OpenStack Developers mailing list], using the [metrics] topic | ||
| + | * If errors are found in the toolset chain, those are free software projects as OpenStack and specific ticketing systems, mailing list discussion and IRC channels are provided. For more information, please visit the [http://metricsgrimoire.github.io/ main page of the Metrics Grimoire toolset]. | ||
| + | |||
| + | === Next Steps === | ||
| + | The Activity Board project already contains all the code needed for the web frontend. And the following code to be added: | ||
| + | * Upload config file to run the whole Metrics Grimoire chain | ||
| + | * Add dependencies in terms of JavaScript libraries such as Bootstrap, JQuery of VizGrimoireJS | ||
| + | * Add specific R files to use the VizGrimoireR library that retrieves all of the information needed to run the OpenStack Activity Board. | ||
| + | |||
| + | [[Category: resources]] | ||
Latest revision as of 21:23, 26 March 2015
Contents
Mission
The goal of the Activity Board project is to provide a dashboard of software development activity metrics of the OpenStack community.
Description
The current version of the Activity Board project only contains the web front-end needed to navigate through the several perspectives of the OpenStack software development process. This is based on the analysis of the repositories of information used by the community as basic infrastructure: versioning system, issue tracking system, mailing lists and others.
The outcomes of this project can be divided into two main groups:
- Open data: OpenStack software repositories are publicly available. And such repositories contain loads of dataset about how the OpenStack community behaves and evolves through time. The Activity Board project aims at providing such raw data in a more human-readable format and aggregated in databases and other formats.
- Metrics browser: this product visualizes that parsed open data and provides specific visualizations. Indeed, the proposed visualization can be easily extensible by the community and third parties. Given its extensibility, in the current version of the Activity Board, there are three main frontends: General Overview of the activity, releases study and actionable dashboard.
Deployed Studies
Current version of the Activity Board provides several faces of the OpenStack project: Development Activity Browser, Releases and Companies study, and Actionable dashboard. Each of this parts of the Activity Board was built with a specific goal.
Development Activity Browser
The Development Activity Browser aims at providing a common place for those interested in the OpenStack Foundation development activity. This provides detailed information about each of the data sources analyzed (Gits, Launchpad, Gerrit and Mailing lists), stressing the point of the community and its evolution.
The list of projects are based on those that appear in the OpenStack Foundation Programs.
Releases and Companies Browser
The Releases and Companies Browser provides an analysis of the community with special emphasis in the companies participating in each release and their developers.
This browser allows to understand how the evolution of the main companies took place during specific releases (even during the whole history of the project). In addition it is possible to navigate through the several data sources analyzed and even at the level of providing information per company.
Actionable Dashboard
The Actionable Dashboard is probably the most powerful of the three analysis. Indeed this allows the user to create charts from scratch selecting among metrics, companies, projects and dates (releases and years).
Toolset
The Activity Board consists of three steps:
- Retrieval process
- Filtering and parsing process
- Visualization
Retrieval
Information is parsed from software development repositories and stored in MySQL databases. Software development repositories are any type of data source with activity of interest for developers and the OpenStack community in general. Examples of this type of data sources are the versioning systems such as Git, mailing lists for discussions, the Launchpad ticketing system or the Gerrit activity.
The data mining toolset is based on the Metrics Grimoire project that provides specific tools for each of the analyzable information data sources.
Visualization
The final part of this process consists of the visualization, where those JSON files are feeded to the VizGrimoireJS library, that builds the web frontend necessary to navigate through the several aspects of the OpenStack project.
How to contribute
This projects follows the general software development process of the OpenStack project. A bit more of information can be found in the Developer's Guide.
Besides, you can collaborate with the project using the following channels:
- Git repository: http://git.openstack.org/cgit/openstack-infra/activity-board/
- Launchpad OpenStack Community project using the tag activityboard
- OpenStack Developers mailing list, using the [metrics] topic
- If errors are found in the toolset chain, those are free software projects as OpenStack and specific ticketing systems, mailing list discussion and IRC channels are provided. For more information, please visit the main page of the Metrics Grimoire toolset.
Next Steps
The Activity Board project already contains all the code needed for the web frontend. And the following code to be added:
- Upload config file to run the whole Metrics Grimoire chain
- Add dependencies in terms of JavaScript libraries such as Bootstrap, JQuery of VizGrimoireJS
- Add specific R files to use the VizGrimoireR library that retrieves all of the information needed to run the OpenStack Activity Board.
