Google Season of Docs 2020

Welcome to Google Season of Docs with Codeuino

Google Season of Docs is a global program which encourages technical writers to gain an exposure to documentations of real-world open source project scenarios either by building a new documentation set, or redesigning the existing docs, or improving and documenting the open source community's contribution procedures and on-boarding experience to transmute their technical skills to greater levels

Google awards stipends, to all successful technical writer who complete their documentation of open-source projects under Codeuino. Alongside Codeuino community members volunteer as "mentors" to aspirants, who assist them about their summer documentation projects and succeed their projects in an expected way.

To learn more about this year's event and how GSoD works, please refer to the Frequently Asked Question (FAQ).

We are applying to Google Seasons of Docs, accepted organizations will be announced on May 11,2020. We already have many project ideas posted below, and we welcome potential participants and mentors to reach out to us.

Get in Touch with us

The Organisation administrators for GSoD 2020 are Devesh Verma followed by co-organisation administrator

  • Org Admin contact: Devesh Verma and

    Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community.

  • SLACK Discussion platform: Join to interact with community!

  • Contact Email: gsod@codeuino.org

Involving as a Student under Codeuino

The application form will be available in the Technical Writer Guide during the technical writer application phase.

Before Being Accepted

If you are a student, you can start exploring project ideas towards the GSoD application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects.

  1. Become familiar with Codeuino Community and the project(s) for which you're applying. Read the Get Involved Guide and ask others in the community if you have questions. If you ask questions the smart way, you'll get better responses.

  2. Make sure your development environment is installed and running, and optimized for maximum efficiency.

  3. Review project ideas listed here & ask questions about those or other projects in the here

  4. Spend as much time as possible in our SLACK channel. Here is the link to join the communication channel.

  5. Introduce yourself within the community.

  6. Run, Test and identify some potential documentation related issues in Codeuino Github Repositories

  7. Increase your visibility by suggesting ideas Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome.

  8. Get Knowledge about GSoD by understanding it and reading about it on their Manual

NOTE: Students can also propose their own ideas that they want to include within the community which they feel like there needs to be an improvement in the documentation.

After Being Accepted

  1. Set up a blog for your work on open source projects, including GSoD. If you don't have a blog yet, you should create one and you would be asked to write within the community guidelines. You will be required to write a blog post every week about your planning work and project progress during GSoD. This will be "Progress Report".

  2. Contact your mentor immediately. Make a plan to communicate with them regularly. You would be required to communicate publicly within the #gsod channel inside the SLACK unless something is private.

  3. Prepare a detailed project plan together with your mentor. This will include setting up milestones for every week.

  4. Prepare mid-term & final project presentation videos about your project's status, progress, and any questions you have for the community.

    You will asked to submit it through google drive which can be published from "Codeuino YouTube Channel"

  5. Attend weekly meetings with potential mentors explaining them your work in every week through Google Hangouts.

After Completion of GSoD

  1. Write a final blog post summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog.

  2. Stay involved with your project or other projects as your schedule permits! There is always plenty of development work needed.

  3. Continue to be involved with Codeuino Community for additional questions or feedback about your GSoD project, and for other topics that interest you.

  4. Present your project in events, Conferences and other related meetups.

  5. Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in, and other related programs.

Involving as a Mentor

Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. The person who is willing to mentor takes up the project within the community and propose it under GSoD on the basis of involvement and prior knowledge of tech writing in it.

Mentoring takes about 5 to 6 hours of work per week (more at the start, less at the end). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time.

Consider proposing your own ideas as well that match the community project style.

Make sure you get through the "Mentor Guide"

Expectations from a mentor

  1. Commit to spending a minimum of 4 hours each week to be available to guide and mentor students (not just your assigned student).

  2. Commit to being present in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week.

  3. Prepare a good overview of your project idea(s)

  4. Review student proposals and work with other mentors and organization admins to select the best candidates for Codeuino.

  5. Ensure your Student is Active. They should have a good community involvement and good discussions. Should be answerable wherever they are tagged.

  6. Reach out to the Season of Docs organization administrators if you have questions or concerns.

  7. Do weekly meeting with students and give weekly report to Organization Admins.

Project Ideas

IDEA 1: Refactoring General Community and DONUT project Docs

Priority:

High

Description:

This is a long run project and the Technical Writer is required to work on two parts under this section.

PART 1: Donut Platform is a flexible open source Social Network Kit that aims to give you the customized social network, social intranet or huge social enterprise application for communities that really fits their needs.

Technical Writer is asked to elaborate on each part of the project through documenting the docs for Front-end, Back-end API Docs and Design work flow.

Front-end Docs: You are required to work on the Installation Guide and Configured modules including the Admin Dashboard work flows which can be achieved by the moderators for this platform. Development of configuration mechanism is one of our newest additions to our installation frameworks of Donut Platform. Currently Donut is central hosted but aims to get bundled as FOSS/OSS tool. So, the task of this major project is to draft an Admin Management System that will allow individuals or community admins to setup for themselves. To simplify the configuration, these predefined modules will have the most common use cases with different options for modules and settings while setting up this environment. Some examples of modules include: Login/Sign Up Authentications, Real time Notification,etc.

Back-end Docs: Server Side includes drafting the docs for the APIs for POST, EVENTS and PROJECTS.

Design Workflow: Understanding the UI/UX layouts and drafting those steps and explanation for various things used within it. Within the design tech writer has to define all the colors, fonts, styles and much necessary things.

PART 2: This part contains refactoring the general documentation for the community; explaining the vision and mission, community guidelines, contributor page and FAQ about Community.

All the Community Docs can be found at docs.codeuino.org

Required Skills/knowledge:

  • Good knowledge of Markdown/writing

  • Brief knowledge of project DONUT

  • UI/UX experience is also required

Difficulty Level:

Moderate

Expected Outcome:

This task will have a well formatted documentation that will help users to surf about it easily.

Potential Mentors:

Devesh Verma and Vaibhav D. Aren

IDEA 2: Writing API docs for codebadge bot and machine learning module for Codebadge project

Priority:

High

Description:

This is a long run project and the Technical Writer is required to work on two parts under this section. CodeBadge is a project which considers official GitHub API and makes a fading badges graph for each organization. It contains two user interaction panels. Admin panel and codebadge bot. Admin panel is admin setup and dashboard section where user can set up the organization account with codebadge once he has installed codebadge bot for the Github organization. The codebadge bot will interact on the Github panel in the comment section of issues and pull request. The user will be updated of the badge updates and also if any comment has been detected inappropriate. The contributors will be allotted points for any kind of contribution to the project and will be assigned badges accordingly. This project will mainly be focused on writing bot related documentation and machine learning documentation.

Codebadge Bot: You are required to work on the Installation Guide and Configured the app. You will need to elaborate on what are the event calls the bot will be triggered and how will the point system will work along with the bot in coordination with these requests. There is a need for proper API documentation for each event being handled by the bot. The major requirement to work on this section is to understand what all rules the point are allowed and when will bot trigger to comment on this section.

Machine Learning Module: You are required to write docs for machine learning module. All the machine learning API request handled by flask API. There are two separate sections for which module handles ML request:-

1. Github events:- the module analysis lots of events such as comments for hate speech, issue summarization and issue importance analysis.

2. Illustrator events:- Codebadge illustrator events are all image-based machine learning handled requests.

Requirement:- Basic experience with probot Github app and how Github events work.

All the Community Docs can be found at docs.codeuino.org

References: Open Collective Guide, Slack Documentation

Required Skills/knowledge:

  • Good knowledge of Markdown/writing

  • Brief knowledge of project Codebadge

  • experience with machine learning and image processing

  • experience of working with probot

Difficulty Level:

Moderate

Expected Outcome:

This task will have well-formatted documentation that will help users to surf about it easily.

Potential Mentors:

Devesh Verma, Vaibhav D. Aren and Ayush Nagar

IDEA 3: Detailed Frontend and Backend docs for Codebadge Project

Priority:

High

Description:

This is a long run project and the Technical Writer is required to work on two parts under this section. CodeBadge is a project which considers official GitHub API and makes a fading badges graph for each organization. It contains two user interaction panels. Admin panel and codebadge bot. Admin panel is admin setup and dashboard section where user can set up the organization account with codebadge once he has installed codebadge bot for the Github organization. The codebadge bot will interact on the Github panel in the comment section of issues and pull request. The user will be updated of the badge updates and also if any comment has been detected inappropriate. The contributors will be allotted points for any kind of contribution to the project and will be assigned badges accordingly. This project will mainly be focused on writing frontend and backend related documentation.

Technical Writer is asked to elaborate on each part of the project through documenting the docs for Front-end, Back-end API Docs and Design work flow.

Front-end Docs: You are required to work on the Installation Guide and Configured modules including the Admin Dashboard work flows which can be achieved by the moderators for this platform. Frontend will have two types of login through github views:- 1. Admin view 2. Contributor view. You need to design docs for both the types of login workflow.

Back-end Docs: Server Side includes drafting the docs for the APIs for POST, EVENTS and PROJECTS.

Design Workflow: Understanding the UI/UX layouts and drafting those steps and explanation for various things used within it. Within the design tech writer has to define all the colors, fonts, styles and much necessary things.

All the Community Docs can be found at docs.codeuino.org

References: Open Collective Guide, Slack Documentation

Required Skills/knowledge:

  • Good knowledge of Markdown/writing

  • Brief knowledge of project Codebadge project

  • UI/UX experience is also required

Difficulty Level:

Moderate

Expected Outcome:

This task will have a well formatted documentation that will help users to surf about it easily.

Potential Mentors:

Devesh Verma, Vaibhav D. Aren and Ayush Nagar