Summer OSPP Idea: Expanding and restyling the GrimoireLab tutorial

[vchrombie]

GrimoireLab is a powerful open-source platform that provides support for monitoring and in-depth analysis of software projects. It produces a rich set of metrics with data extracted from more than 30 tools related to contributing to Open Source development such as version control systems, issue trackers, and forums. These metrics are shown and exploited on Web dynamic dashboards, which can be easily inspected by decision-makers to help them understand the evolution and health of their projects.

The main entry point to learn about GrimoireLab is the tutorial, which provides a walkthrough of the platform and its components. Recently, the community has requested to revamp and expand its content to include additional information such as dashboard customization and management.

The aims of the project are:

• Refactor the content of the tutorial with the TOC proposed in the issue
• Revamp the content of the tutorial. Some content can be taken from chaoss/grimoirelab,, chaoss/grimoirelab-sirmordred, Bitergia/c/FAQ, jsmanrique/grimoirelab-user-guide
• Restyle the tutorial with a new template
• Replace the current images with new ones. Some images can be taken from jsmanrique/grimoirelab-user-guide
• Align the new content with the getting started guides available in the different GrimoireLab components

The aims will require creating central documentation for GrimoireLab using Markdown and Jekyll from the various resources and existing documentation.

• Difficulty: Medium
• Language: English
• Requirements: Interest in software analytics. Python programming. Writing technical documentation (preferably in English). Willingness to understand GrimoireLab internals.
• Recommended: Experience with Python, Markdown, Jekyll, and Docker would be convenient but can be learned during the project.
• Mentors: @vchrombie @GeorgLink @jsmanrique

Microtasks

For becoming familiar with GrimoireLab, you can start by reading some documentation. You can find useful information at:

• GrimoireLab Tutorial
• Getting Started - GrimoireLab
• The GitHub repositories hosting the tools (chaoss/grimoirelab-perceval, chaoss/grimoirelab-elk, chaoss/grimoirelab-*...).

Once you're familiar with GrimoireLab, you can have a look at the following microtasks.

• Microtask 1:
  Set up GrimoireLab in your machine. The most simple method is using the docker-compose. You can use this blog post for reference, Simplifying how to install GrimoireLab.

• Microtask 2:
  Learn about setup.cfg & projects.json and set up data collection for the GrimoireLab project using SirMordred. Feel free to choose any backend and the projects.

• Microtask 3:
  Now that you have the data in the ElasticSearch, create a new visualization using the data (see schema to understand data; see Kibana docs for how to create a visualization).

• Microtask 4:
  Write a markdown file describing your process of creating the new visualization, include an explanation for each step, include screenshots, share the link to the markdown file.

• Microtask 5:
  Submit at least a PR to one of the GrimoireLab repositories to fix an issue/typo, improve the documentation, etc.

Note: Please make sure you go through the guidelines for participating in the program. Also, you are expected to add your name and details to the Summer-OSPP-interest.md in the chaoss/governance repository. Your application won't be considered for evaluation if you miss this step.

[vchrombie]

For all students interested in this idea, please comment on this issue to get in touch with the mentors. This is the main communication channel.

[Aju100]

Hi @vchrombie,

I am interested to work this issue and have a mentorship for OSPP one.

[vchrombie]

Thanks for your interest, @Aju100. Please go through the guidelines and process of the program. You can start working on the microtasks and the proposal. Let us know if you face any problems. 🙂

[VSevagen]

Hi there !
My name is Sevagen and I'm an undergrad student from Amrita Vishwa Vidyapeetham, Amritapuri Campus, Kerala, India. I would like to work on this idea for Summer-OSPP 2021. I already started working on the microtasks and I will try my best to complete them before the proposal submission.

[vchrombie]

Hi @Aju100 @VSevagen
Thanks for showing interest, please let me know if you want me to review your microtasks or need any help with any doubts. 🙂

Best,
Venu

[vchrombie]

Hi everyone

To all the interested candidates who are applying for this idea, please make sure you open a PR and add your details to this Summer-OSPP-interest.md file. This is needed as a part of the CHAOSS Guidelines.

Please let me know if you have any issues.
Thanks.

[vchrombie]

Thanks to everyone who showed interest in the idea and worked on the application.
Congratulations to @VSevagen for being selected for the project.

If you have any questions, comments, or concerns about the selection process, feel free to send an email to [email protected]. Thanks!

This issue is going to be closed on Friday.