How to contribute

This training manual is built using Markdown syntax, and the Documentation Theme for Jekyll, for rendering the HTML pages. All the Markdown files and Jekyll configuration files are maintained in the chaoss/grimoirelab-tutorial GitHub repository.

Pull requests to that repository are welcome. If you prefer, you can also open some issue on it, to report some bug, to propose some enhancement, to ask for some new content, or just to comment or suggest something. Any feedback is appreciated!

If you want to produce your own version of the HTML pages from the sources, ensure you have Ruby installed, and:

% git clone https://github.com/chaoss/grimoirelab-tutorial
% cd grimoirelab-tutorial
% bundle exec jekyll serve

This will produce the HTML files, and run an HTTP server that will serve them in http://localhost:4000

Contributors

  • The example about producing a dashboard for Meetup was contributed by Manrique L√≥pez de la Fuente (Bitergia) in March 2017.

  • The section on Perceval backend is based on a contribution by [Valerio Cosentino[(https://github.com/valeriocos)(Bitergia) in October 2017.