Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======Google Season of Docs 2021: CHAOSS projects======

[[:gsoc:google-season-of-docs-2021|Main GSoD Linux Foundation page: How to apply, deadlines, other workgroups, ...]]
=====Contact=====

**Important:** We protect the e-mail addresses of our mentors and mailing lists against spam bots. Please replace all occurrences of " at " and " dot " by "@" and "." resp.

CHAOSS Mailing List: https://lists.linuxfoundation.org/mailman/listinfo/chaoss

CHAOSS Diversity & Inclusion WG Mailing list: https://lists.linuxfoundation.org/mailman/listinfo/chaoss-diversity-inclusion

Website: https://chaoss.community/

GitHub: https://github.com/chaoss/

=====Organization Administrators=====

The participation of the Linux Foundation in the Google Season of Docs is organized by Till Kamppeter (till at linux dot com) and Aveek Basu (basu dot aveek at gmail dot com).

======Project Ideas======

=====Write a conceptual overview of CHAOSS D&I metrics and refactor existing documentation=====

Work with CHAOSS D&I working group members to develop a conceptual framing for D&I metrics. The work so far has focused on defining individual metrics, resulting in much detail that is not uniformly presented. A technical writer can improve the information architecture, revise how a reader can drill down into the details, and make it easier to understand D&I metrics as a whole. The documentation would be collected in the CHAOSS D&I repository and could additionally be prepared for other dissemination forms to reach a wider audience. 

Knowledge/Skills Involved: Being a good human with good ethics. GitHub-Flavored Markdown and Workflow, HTML Inlines/Tables, Vector/Raster Images Requirements.

Aims of the project: Make the work of the CHAOSS D&I Working Group more available.

Mentors: Georg Link (linkgeorg at gmail dot com); Matt Germonprez (germonprez at gmail dot com) 

References: https://github.com/chaoss/wg-diversity-inclusion

License: MIT

=====Build documentation for D&I Badging project=====

The CHAOSS Diversity and Inclusion Badging Program began as a way to ensure that D&I metrics can have a significant impact on the ways that communities function. The aim of the CHAOSS D&I Badging program is to bring D&I metrics into use for propelling good D&I practices in different open source systems.

This project will focus on framing documentation for the D&I Badging program and aligning it in such a way that it makes sense after translation. This work would focus on more community-facing docs related to Badging and also on existing Markdown files.

Knowledge/Skills Involved: Citizen of the world with editorial affinity across languages, GitHub-Flavored Markdown and Workflow, HTML Inlines/Tables, Vector/Raster Image Requirements.

Aims of the project: Write and structure D&I Badging documentation. Prepare documentation for easy translation.

Mentors: Matt S., Aastha Bist (chaoss-badging at googlegroups dot com)

References: https://github.com/badging

License: MIT

=====Expanding and restyling the GrimoireLab tutorial=====

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 [1], 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 [2].

Knowledge/Skills Involved: Python, Jekyll, and Docker are suggested technology to know, but can be learned during the program.

Aims of the project:
  * Refactor the content of the tutorial with the TOC proposed in the issue [2] 
  * Revamp the content of the tutorial. Some content can be taken from [3-9]
  * Restyle the tutorial with a new template
  * Replace the current images with new ones. Some images can be taken from [9] 
  * Align the new content with the getting started guides available in the different GrimoireLab components

Mentors: Animesh Kumar, Aniruddha Karajgi, Venu Vardhan Reddy Tekula, Valerio Cosentino

License: CC BY-SA 4.0 (the same of the tutorial: https://github.com/chaoss/grimoirelab-tutorial/blob/master/LICENSE.md)

References:
  - https://chaoss.github.io/grimoirelab-tutorial/
  - https://github.com/chaoss/grimoirelab-tutorial/issues/104
  - https://github.com/chaoss/grimoirelab#getting-started
  - https://github.com/chaoss/grimoirelab-sirmordred#sirmordred-
  - https://github.com/chaoss/grimoirelab-sirmordred/blob/master/Getting-Started.md
  - https://gitlab.com/Bitergia/c/FAQ
  - https://gitlab.com/Bitergia/c/FAQ/-/tree/master/_old_stuff/identities
  - https://github.com/chaoss/grimoirelab-hatstall/tree/master/docs
  - https://github.com/jsmanrique/grimoirelab-user-guide

=====Create a CHAOSS Community-wide Handbook=====

Work with CHAOSS members to develop a community handbook. Currently, working groups have developed their own ways of working and documented their disparate processes to varying degrees. The goal of the community handbook is to centralize critical information and standardize parts of it across the CHAOSS project. The handbook should serve as an instruction manual for existing and new community members on how to get work done in the CHAOSS project. This project involves a creative component of collecting and organizing content for the handbook as well as a technical component of defining how to represent the handbook.

Knowledge/Skills Involved: Being a good human with good ethics. GitHub-Flavored Markdown and Workflow, GitHub Pages, HTML Inlines/Tables, Vector/Raster Images Requirements.

Aims of the project: Create a Community Handbook for the CHAOSS project.

Mentors: Armstrong Foundjem (foundjem at ieee dot org); Georg Link (linkgeorg at gmail dot com)

References: https://github.com/chaoss/governance/tree/master/community-handbook

License: MIT

=====Create a CHAOSS / Augur Developer Guide for Moving Data Exploration into New Metrics=====

Work with CHAOSS members, including Augur developers, to document how we move from exploration of Augur's schema with jupyter notebooks to the development of new Augur Endpoints, and new CHAOSS Metrics. Currently, the iterative process of metric definition and implementation occurs in an ad hoc manner. The goal of the community augur developer guide is to make the process of asking a question using Python or SQL, into formalized CHAOSS Metrics, and implemented Augur code. The guide should serve as an instruction manual for existing and new community members on how to answer the questions they have using Augur data, and then helping contribute to the Augur software and the CHAOSS project. This project involves a creative component of collecting and organizing content for the handbook as well as a technical component of defining how to represent the handbook.

Knowledge/Skills Involved: Being a good human with good ethics. Familiarity with RestructuredText, GitHub Pages, and image placement.

Aims of the project: Create an Exploration to Metrics Guide for the Augur and CHAOSS projects.

Mentors: Sean Goggins, Carter Landis, Gabe Heim

References: https://oss-augur.readthedocs.io/en/master/

License: MIT
Wiki

User Tools

Site Tools

Page Tools
