Coder Social home page Coder Social logo

jaskiratsingh2000 / google-season-of-docs Goto Github PK

View Code? Open in Web Editor NEW
9.0 3.0 4.0 5.8 MB

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

License: MIT License

gsod gsod-2020 chaoss linux-foundation opensource project-tracker season-of-docs community-health community-handbook

google-season-of-docs's People

Contributors

jaskiratsingh2000 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

google-season-of-docs's Issues

[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] "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] "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

[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

[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 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

[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)

[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

[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

[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)

[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.

[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] 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)

[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] 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

[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

[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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.