jaskiratsingh2000/google-season-of-docs

Project Tracker for Google Season of Docs 2020: Creating a @chaoss Community-wide handbook

Google Season of Docs 2020

A full report on my Google Season of Docs 2020 work with CHAOSS Project under The Linux Foundation

Creating a CHAOSS Community-wide Handbook

Project Abstract | Discussions | Weekly Updates | Final Verdicts | Commits | Links

Project abstract

Currently, working groups within the CHAOSS community have developed their own ways of working and documented their disparate processes to varying degrees. Working Groups includes Common Metrics WG, Diversity & Inclusion WG, Evolution, Risk, and Value working groups which have set up their own participating and working ways and adapted different ways of communication and work culture. These working groups in accordance with metrics have different focus areas and backgrounds which works for appropriate metrics lead various researches and development under respective working groups category and know the right pathway to lead various researches and development under respective categories but the processes for newcomers and existing contributors may not be known that how to participate or take the right path to for respective workings. As a result of this, the things within the CHAOSS community are not standardized. Therefore to know the right process and basic fundamentals of the work culture across the community, the goal of the community handbook is to centralize critical information and standardize parts of it across the CHAOSS project. The critical information and standardization parts majorly focus on the processes that CHAOSS uses so that CHAOSS have the agreement of how community accomplishes work, How newcomers can participate and follow the fundamentals of the community and what processes and pathway newcomers or existing members have to follow for availing the leadership within the CHAOSS community.

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.

Mentors: Georg J.P.link, Matt Germonprez, Armstrong Foundjem

NOTE: There are some tags used below which have got the following meanings.

• Pending: The work is in progress and is under development due to current state.
• Yet To Be Done: This indicates that it will be done in the future as it is yet to be implemented

Weekly Updates

Community bonding (August 17, 2020 - September 13, 2020)

• Week 1 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 1
• Week 2 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 2
• Week 3 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 3
• Week 4 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 4

Doc Development (September 14, 2020 - November 30, 2020)

• Week 5 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 5
• Week 6 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 6
• Week 7 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 7
• Week 8 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 8
• Week 9 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 9
• Week 10 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 10
• Week 11 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 11
• Week 12 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 12
• Week 13 - Weekly Summary: Weekly Report | Blog Post: Google Season of Docs: CHAOSS Project under The Linux Foundation — Week 13

Final Verdict

🪂 Final Evaluation Period (November 30, 2020 - December 5, 2020): Yet To be Done

Commits

• Commits done on gitbook-test repository: This contains all my GitHub commits made on the gitbook-test repository in-accordance with GitBook platform.

Repository URL

gitbook-test

Links

• GSoD 2020 CHAOSS Proposal - Jaskirat SIngh
• Project Link on GSoD website

Footnotes

• We have weekly meetings over google meet on every thursday at 7:30 pm IST
• I will be writing the blogs every week
• I will be writing my daily basis scrum documentation in respective week file

Want to connect with me?

• Connect with me on LinkedIn
• Give a follow on GitHub
• Follow me at Twitter

google-season-of-docs's Issues

[Documentation] "Design Contribution" page for the Community Handbook

For any open source community, it is very important to outline the contribution guidelines required for a different field. So here by I have drafted the contribution guidelines for the design.
I have tried to explain the following things:

• Things you need to follow
• Different Design Contribution
• Getting Started

Link to gitbook

[Documentation] "Design Workflow" of the CHAOSS community in the Handbook

After making fair research on the "Design Workflow" I wrote the following things under this specific page:

• Our Process - which follows general query system that one use to overcome any design problem
• Ways of Achieving
  • Added a design(made by me)
  • Explaned the different steps

[Documentation] "Design" page of the CHAOSS in the Community Handbook

After making good research for this page. I figured out the following things to mention on the page:

• CHAOSS Logo
• What is CHAOSS design?
• What are we trying to achieve?
• How you can contribute?

Link to GitBook

[General] Updating the community with Week-3 progress

• Week 3 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[General] Adding "Deliverables" in the GSoD Project Tracker

Georg provided me the suggestion to mention the goals for each week so that it is easy to compare my progress.

[Documentation] CHAOSS "Community Guidelines" section

After doing fair research around the CHAOSS community guidelines, I drafted them on the GitBook platform and the Google Docs.
These are the following things I wrote as headlines:

• Be welcoming and open-minded
• be honest
• Be respectful
• be collaborative
• be inclusive
• Be focused
• Be mindful and stay on topic
• Share the love
• What is not allowed?
• What happens if someone breaks the rule?

Link to GitBook
Link to Google Doc( which is being used for feedback and improvements)

[General] Updating the community with the Week-6 progress

• Week 6 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[Documentation] "Design Contribution" page for the Community Handbook

https://handbook.chaoss.community/community-handbook/contributing/design/design-contribution

[Research] "Path to Leadership" section in the Community Handbook

• Read some articles
• Explored the website
• Discussing with community memebers

[Research] "General values" section under The CHAOSS Community way

• Exploring the already existing community handbook on the GitHub and understood the various insights into it
• Talk with the CHAOSS community members and discussing on what "Values" being lived out within the community
• Asked for the references supporting any values that being lived out.

[Documentation] "General FAQ" for the Community Handbook

Wrote about the General FAQ which usually people come across inside the CHAOSS community. All the content can be found on this page https://handbook.chaoss.community/community-handbook/about/general-faq

[Documentation] CHAOSS "Working Groups" section for Community Handbook

after making fair research and understanding the Working Groups, I drafted them into the GitBook and the Google Doc
Following are the headlines I used and prepared a context for them:

• What is the Working Group?
• Types of CHAOSS Working Groups
• Who all can participate?
• How to define any new focus area of metrics inside any working group?
• What is the workflow and culture inside the working groups?

Link to GitBook page
Link to Google Doc(for improvements and feedback)

[General] Announcing new link of the handbook on the CHAOSS mailing list

As mentioned by Georg, I have synced up the repository of the previous community handbook with the new on the gitbook. I have to announce the new link on the mailing list of the CHAOSS

[Research] CHAOSS "Community Guidelines" section

• Exploring the website and understood the various insights about the ethics being followed in the CHAOSS community
• Talk with the CHAOSS community members and discussing on what "Guidelines" to draft
• Asked for the references supporting any values for the guidlines that being lived out.

[General] Updating the community with the Week-12 progress

• Week 12 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter

[Documentation] "Outreachy" section in the Community Handbook

I planned to write the Outreachy section for the CHAOSS community as CHAOSS has been participating for many years. So there should be the way for newcomers and existing contributors to understand the CHAOSS's participation in the Outreachy program

• Explored the Outreachy website
• Explored the CHAOSS previous years project
• Explored the governance of the CHAOSS on the Github which contains the directory of Outreachy
• Discussion with the community members

[Documentation] "Outreach Guidelines" for the Community Handbook

Outreach plays a vital role for any open source community/project. Keeping this thing into consideration I planned to write the Outreach Guidelines inside the community-handbook.
I wrote different ways to get involved with the outreach contribution:

• Writing Blog Post
• Social Media
• Merchandise
• Organize Conferences and Meetups

[Documentation] "Google Season of Docs" section in the Community Handbook

I planned to write the Google Season of Docs section for the CHAOSS community as CHAOSS has been participating for many years. So there should be the way for newcomers and existing contributors to understand the CHAOSS's participation in the Google Season of Docs program

• Explored the Google Season of Docs website
• Explored the CHAOSS previous years project
• Explored the governance of the CHAOSS on the Github which contains the directory of GSoD
• Discussion with the community members

[General] Updating the community with the Week-13 progress

• Week 13 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter

[Research] "Design Workflow" of the CHAOSS community

I planned to write the Design Workflow for the CHAOSS community. After making a bit of research I tried to understand the workflows aim.

• Explore the website
• Read Articles
• Understand the other community's flows

[General] Added basic working structure

• Set up the GSoD Project Tracker
• Set up blogs for posting a weekly blog posts
• Discuss and schedule the meeting timings
• Set up the technical writing platform

[Documentation] "Terminology" section in Community Handbook

After making a fair research about the Terminology section. I planned to write the following things within the Community Handbook:

• CHAOSS Specific Terms
  • Open Source Community Health
  • Code Review
  • Open Source Software Metric
  • Metric Release
  • Focus Area
  • CHAOSScon
  • CHAOSScast
  • CHAOSSblog
  • CHAOSStube
  • CHAOSSweekly
  • Charter
• CHAOSS Committees
  • CHAOSS Project
  • Contributor
  • Organization
  • Community
  • Community members
  • Core Contributors
  • Maintainers
  • Working Groups
  • Governance Board
  • Event Attendee
  • CHAOSScon Organizing Committee Member
  • CHAOSS Metric Release Collaborator
  • Mailing List Moderator
  • CoC Enforcement Team Member
  • Twitter Manager
• CHAOSS Community Working Groups Terminology
  • Common Metric
  • Diversity & Inclusion
  • Evolution
  • Risk
  • Value
  • Grimoirelab
  • Augur
  • Cregit
  • Application Ecosystem
  • Diversity&Inclusion Badging
• CHAOSS Community Mentorship Terminology
  • Organization Administrators
  • Mentors
  • Mentee/Student
  • CHAOSS Mentorship Alumni

[Documentation] "Roadmap" section in Community-Handbook

After making me the fair knowledge on the Roadmap, I wrote about that within the gitbook https://handbook.chaoss.community/community-handbook/about/roadmap

[General] Updating the community with the Week-7 progress

• Week 7 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[Dcumentation] "Documentation Contribution Guidelines" for Community-Handbook

After making a fair research about the "Documentation Guidelines" I wrote the basic understanding/requirements for contributing in documentation under CHAOSS. The page can be found here(https://handbook.chaoss.community/community-handbook/documentation).

I also tried to explain the basic workflow to follow by taking GitHub into consideration. The link to the page can be found here(https://handbook.chaoss.community/community-handbook/documentation#getting-started)

[General] Updating the community with the Week-8 progress

• Week 8 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter

[General] Updating the community with Week-2 progress

• Week 2 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[Documentation] "Values" section under The CHAOSS Community way

After receiving inputs from the CHAOSS community members through the mailing list. I drafted the following things in the GitBook platform:

• Sustainability
• Openness
• Transparency
• Diversity, Inclusion & Belonging
• Consistency
• Merit
• Trust
• Utility

Link to GitBook
Link to Google Doc( which is being used for feedback and improvements)

[General] Updating the community with the Week-10 progress

• Week 10 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter

[Research] "Documentation Contribution Guidelines" for Community-Handbook

This section will give an overview of how one can get involved with the CHAOSS community as a developer.
I planned to explore the following things in order to figure out what to write:

• CHAOSS website defining projects
• GrimoireLab project guidelines
• Augur project guidelines
• Cregit project guidelines
• reading the CONTRIBUTING.md

[General] Updating the community with the Week-9 progress

• Week 9 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter

[Research] "Design" page of the CHAOSS in the Community Handbook

Design is very important for every community as it helps us to know the basic design principle and the workflow of the community.
In order to write this specific page, I tried researching out the following things:

• Explored the CHAOSS community website
• Read articles online that defines design principles
• Understanding the other community design pages

[General] Organising meetings with core community member fo CHAOSS History

Organize meetings with the core community member in order to understand their background with CHAOSS and CHAOSS history.

[General] Updating the community with Week-5 progress

• Week 5 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[Research] CHAOSS "Working Groups" section for Community Handbook

Working Groups are the group of people leaving various groups under the community whose goal is to refine the metrics and to work with software implementations. The workgroups are built around the four categories of metrics that CHAOSS has identified.
Following things required:

• Exploring the website and understood the various insights about the Working Group
• Exploring the Github repositories of Working groups
• Talk with the CHAOSS community members and discussing the requirements to be written for community handbook under the working group's sections
• Asking for the references supporting the context

[Documentation] Terminology Usage Guidelines in Community Handbook

Wrote the Terminology Section within the Gitbook.
Link: https://chaoss-project.gitbook.io/community-handbook/terminology-usage

[General] Updating the community with the Week-11 progress

• Week 11 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter

[General] Updating the community with Week-4 progress

• Week 4 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[Documentation] "Path to Leadership" section

After reading the articles, I started writing the following things:

• What leadership means to the CHAOSS community?
• Why it is important for us?

[General] Updating the community with Week-1 progress

• Week 1 Blog Post
• Scrum Documentation
• jaskiratsingh2000/Google-Season-of-Docs repository updation
• Sharing about progress on Twitter and LinkedIn

[Research] "Terminology" section for Community Handbook

Terminology would help describe the terms and respective belongings that are used frequently within the CHAOSS community. I will also be including the Terminology usage guidelines like Capitalization, Abbreviations, and Words to Avoid with reasons.

• Read some articles for understanding how to define Terminology
• Explored the website
• Discussion with community members

[Documentation] "Metric" in the Community Handbook

While I was applying to the GSoD under CHAOSS back in the month of May, I had made a fair research around the metric system on the CHAOSS community. I was always curious to know that how one can propose the metric and follow the path for its approval.
Taking that into consideration, I planned to write the "Processes for getting approved to be visible on the website" along with the "CHAOSS Metric Committee", and "Useful Resources"

[Research] "Roadmap" section for the Community-Handbook

Roadmap is important for the CHAOSS project as they are working on many aspects. I would be writing the specific targets and goals of the CHAOSS Community in the Roadmap Section of the gitbook.

• Read some articles for understanding how to define Terminology
• Explored the website
• Discussion with community members

[Documentation] "Google Summer of Code" section in the Community Handbook

I planned to write the Google Summer of Code section for the CHAOSS community as CHAOSS has been participating for many years. So there should be the way for newcomers and existing contributors to understand the CHAOSS's participation in the Google Summer of Code program

• Explored the Google Summer of Code website
• Explored the CHAOSS previous years project
• Explored the governance of the CHAOSS on the Github which contains the directory of GSoC
• Discussion with the community members