Sugar Labs - User contributions [en]

Google Code In 2019

2019-10-11T17:30:52Z

Pratul1997: /* Mentors */

<noinclude>[[Category:Trac Reference]][[Category:Idea]]
[[Category: GCI2019]]</noinclude>

Sugar Labs community members: please feel free to add tasks below.

== Message to potential participants ==

It is important that you obtain permission of your parents.

Es importante que obtengas el permiso de tus padres para participar.

Please see the Contest Rules for Eligibility and Registration process.

https://codein.withgoogle.com/student-terms/

Also, you will likely need to set up the Sugar development environment. See http://developer.sugarlabs.org/dev-environment.md.html for details. Further information about contributing to the project can be found here: http://developer.sugarlabs.org/

Please don't hesitate to ask questions on our IRC channel (#sugar on irc.freenode.net) or on the sugar-devel list: sugar-devel AT lists.sugarlabs DOT org
(See [[Google_Code_In_2019#Getting_set_up_on_IRC|below]] for details regarding setting up an IRC account.)

== Why Sugar Labs is participating ==

Sugar is written and maintained by volunteers, who range from seasoned professionals to children as young as 12-years of age. Children who have grown up with Sugar have transitioned from Sugar users to Sugar App developers to Sugar maintainers. They hang out on IRC with the global Sugar developer community and are full-fledged members of the Sugar development team. It is this latter group of children we hope will participate in and benefit from Google Code-in. Specifically we want to re-enforce the message that Sugar belongs to its users and that they have both ownership and the responsibility that ownership implies. Just as learning is not something done to you, but something you do, learning with Sugar ultimately means participating in the Sugar development process. At Sugar Labs, we are trying to bring the culture of Free Software into the culture of school. So the Code-in is not just an opportunity for us to get some tasks accomplished, it is quintessential to our overall mission.

== Some background from GCI ==

[See https://developers.google.com/open-source/gci/resources/getting-started]

===Open Source Fundamentals ===

You can contribute without being a coder!
You do not have to be a coder to contribute to open source. There are many different skill sets needed to help an open source community thrive:
;Documentation: If you are a good writer and enjoy attention to detail then you might want to contribute by writing or editing documentation. Documentation is a huge part of a successful open source project. Organizations need documentation to help attract new contributors as it helps them see what the codebase looks like and where things are and what the plan is for the project.
;Research: An organization may need help crunching numbers or sorting through pages of documents to better understand what the users want or need. There are many different types of tasks that students could work on that are very important to the health of the project.
;Outreach: If you have an outgoing personality and like being around and talking to people, take a look at the outreach tasks. Outreach tasks often include hosting meetups in your local community or creating a plan on how people around the globe can host a meetup about the project in their local communities.
;Training: You could create a YouTube video discussing a new feature of the project or maybe some basics on what the project does so people who haven’t heard about it can understand the project and get involved.
;User Interface: User interface can include many types of tasks including designing new aspects of a web page or creating a new logo for the project. It may also include various accessibility opportunities to help make the project easier for people who are blind.
;Other: If you have an idea that may help an organization, reach out to them and let them know! Sometimes the best task is one that the organization hasn’t even considered yet.
=== Collaboration===
Open source is not just about coding but working with other people to find the best solution. Being a part of the community is an essential part of success in Google Code-in. Mentors tell us every year that their best students were the ones who worked hard on their projects but also participated on IRC and helped answer questions other students had. Collaborate with the community and mentors on the #sugar channel in the irc.freenode.net network.

=== Quality over Quantity ===

It’s not about being the student who completes the most tasks, that only gets you to the top 10 to be reviewed, it doesn’t mean you will be a grand prize winner. We have had quite a few students who completed the most tasks for their organization yet were not named as Grand Prize Winners because they did everything solo and didn’t get involved in the community or think about the health of the project as a whole, they just kept completing task after task like a machine. If you actively participate in the community then you not only feel the camaraderie that comes with working as a team but you become committed to making the project better for everyone.

== Some basics about Sugar Labs and Sugar development ==

For some basics about the project, see [http://people.sugarlabs.org/walter/docs/Learning-to-Change-the-World-Chapter-4.pdf Chapter 4 of Learning to Change the World].

{{:Google Code In 2018/background}}

== This is a stub for 25+ example tasks new for GCI 2019. ==

Note, more detailed task descriptions will be available once the contest begins.

=== Beginner tasks ===
# Install the Sugar development environment by following the instruction at [http://developer.sugarlabs.org/dev-environment.md.html].
# Install Sugar in a virtual machine.
# Install Sugar packages on Ubuntu, Debian, or Fedora.
# Install Sugarizer on a Raspberry Pi for use by nearby computers, tablets, or phones.
# Create an example program in Turtle Blocks (See [https://www.pinterest.com/walterbender/turtle-art/] for some ideas).
# Create an example program in Music Blocks.
# Create a simple machine in Physics.

=== General tasks ===
# Organize a Turtle Art Day (or Music Blocks Day) in your community (Outreach)
# Create a 60 second promotional video on Sugar and its community (Outreach)
# Host a Question and Answer (Q&A)/Information session about Sugar on Google Hangouts. (Outreach)
# DIY Sugar on a Stick||Organize and host a Sugar on a Stick party where you show people how to make their own Sugar on a Stick. (Outreach)
# Find an educator who is using open-source educational software to teach. Interview the educator about their experience as an educator and why they are using open-source software to teach. (Outreach)
# Write a blog post about your experience as a GCI participant for Sugar Labs. (Outreach)
# Create a 10-minute presentation celebrating at least three women within the Sugar community and/or the open-source community at large. (Research/Outreach)
# Gather information on who could benefit from using or knowing about Sugar. (Research)
# Find the resources that people are using throughout the world to learn about or teach Sugar Activities. (Research)
# Find the missing repo: we've lost track of the source repository of some Sugar activities: help us find them (Research)
# Wiki cleanup (Documentation)
# Music Blocks examples (Documentation/Training)
# Write a review about an Activity in Sugar. (Documentation)
# Create a unit tests for a JavaScript activity (Quality assurance)
# Test old Sugar activities and report any really obvious problems (Quality assurance)
# Refactor Turtle graphics to adopt look of Javascript version (Code: Python)
# write a Python/GTK version of Music Blocks
# Investigate CSound/Python version of Music Blocks (Code: Python)
# Resolve an open issue from https://github.com/sugarlabs/ (Code: Python)
# Plugin manager for Turtle JS (Code: Javascript)
# Add Lilypond import to Music Blocks (Code: Javascript)
# Write a Turtle plugin (Code: Javascript)
# Write a extruder in JavaScript to convert from SVG to STL for 3D printing. (Code: JavaScript)
# Write a slicer in JavaScript to convert between SL and GCODE for 3D printing. (Code: JavaScript)
# Resolve an open issue from https://github.com/walterbender/musicblocks/ (Code: JavaScript)
# Port a Sugarizer activity to Sugar (Code: Javascript)
# Port an old Sugar activity to the most recent Sugar (Code: Python)

Mentors: please feel free to add more tasks and/or add yourself as a potential mentor to an existing task.

Tasks must fall within one of these five categories: [[#Documentation/Training]]; [[#Outreach/Research]]; [[#User Interface]]; [[#Quality Assurance]]; and [[#Code]].

== Mentors ==
;NOTES TO MENTORS:
:Please note that not all tasks are coding tasks so please consider participating even if you are not a coder (there are research, outreach, design, and documentation tasks as well).
:But also note that prior participation in the Sugar Labs community is a requirement for mentoring.

Send an email to one of the Org Admins (this year they are Walter and TBD). You will then receive an invitation by email.
Follow the instructions in the email to sign up as a Sugar Labs mentor.
:Please add yourself to the list below.
:Feel free to add new tasks to the table above.

Depending on the task, we will assign multiple mentors from our various development and support teams.

* Walter Bender - co-administrator
* James Cameron - release manager
* Sumit Srivastava - Mentor for Coding, Design, and QA tasks.
* Jaskirat Singh - Mentor for Research, Documentation, Design and Testing tasks
* Vaibhav Aren - Mentor for Coding, Research, Documentation, Design and Testing tasks.
* Hrishi Patel - Mentor for Coding, Research, Documentation, Design and QA tasks.
* Amaan Iqbal - Mentor for Coding, Research, Documentation, Design, and Testing Tasks
* Pratul Kumar - Mentor for Coding, Beginner First Issues, Git and Github, Documentation.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T18:03:47Z

Pratul1997: /* Other Commitments */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information ( like email address, name, handles etc. ) and would allow him to easily share his work and/or collaborate with others.
::* The dashboard can be logged in with Google ID, Github or Facebook ( more login options like single login providers like OneLogin and login using StackOverflow / StackExchange network ID may also be added if needed in future ).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience(a feature of user groups could be added in future).
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be compulsory to view the documentation.'''
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* This will help in several ways:
::* If the user can’t read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repositories.
:* Sugarbot will keep track of the git repositories and issues being opened, and when a label ( like easy, medium, hard, GCI, GSoC etc. ) is being attached to them by the repo maintainer.
:* The bot will automatically reflect issues according to their labels within the corresponding group on the page(a part of our newcomer's guide).
:* If the newcomer wants to start contributing right away, he can view the list of issues label-wise and choose them according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at sugardoc using [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML(then to pdf as needed). Another alternative to display content on our dashboard is using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place, removing other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* Further as only markdown will be used as new-comer guide, other resources have been removed, the community won't need to devote their time in maintaining multiple guides.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized, [https://github.com/coala/coala/tree/master/docs/Developers an example] used by other organization.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* Sphinx also provides the feature to convert the documentation to pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I would like to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will try to keep updating guide and keep working on Sugarbot to make things automated and easy as long as I can.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository. We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester exams are from 29th April to 5th May and next semester will start on 27th July.
::* During my exam tenure, I will not be able to contribute.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:52:55Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information ( like email address, name, handles etc. ) and would allow him to easily share his work and/or collaborate with others.
::* The dashboard can be logged in with Google ID, Github or Facebook ( more login options like single login providers like OneLogin and login using StackOverflow / StackExchange network ID may also be added if needed in future ).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience(a feature of user groups could be added in future).
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be compulsory to view the documentation.'''
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* This will help in several ways:
::* If the user can’t read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repositories.
:* Sugarbot will keep track of the git repositories and issues being opened, and when a label ( like easy, medium, hard, GCI, GSoC etc. ) is being attached to them by the repo maintainer.
:* The bot will automatically reflect issues according to their labels within the corresponding group on the page(a part of our newcomer's guide).
:* If the newcomer wants to start contributing right away, he can view the list of issues label-wise and choose them according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at sugardoc using [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML(then to pdf as needed). Another alternative to display content on our dashboard is using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place, removing other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* Further as only markdown will be used as new-comer guide, other resources have been removed, the community won't need to devote their time in maintaining multiple guides.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized, [https://github.com/coala/coala/tree/master/docs/Developers an example] used by other organization.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* Sphinx also provides the feature to convert the documentation to pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I would like to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will try to keep updating guide and keep working on Sugarbot to make things automated and easy as long as I can.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository. We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:43:34Z

Pratul1997: /* Information */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information ( like email address, name, handles etc. ) and would allow him to easily share his work and/or collaborate with others.
::* The dashboard can be logged in with Google ID, Github or Facebook ( more login options like single login providers like OneLogin and login using StackOverflow / StackExchange network ID may also be added if needed in future ).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience(a feature of user groups could be added in future).
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be compulsory to view the documentation.'''
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* This will help in several ways:
::* If the user can’t read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repositories.
:* Sugarbot will keep track of the git repositories and issues being opened, and when a label ( like easy, medium, hard, GCI, GSoC etc. ) is being attached to them by the repo maintainer.
:* The bot will automatically reflect issues according to their labels within the corresponding group on the page(a part of our newcomer's guide).
:* If the newcomer wants to start contributing right away, he can view the list of issues label-wise and choose them according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:42:55Z

Pratul1997: /* Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information ( like email address, name, handles etc. ) and would allow him to easily share his work and/or collaborate with others.
::* The dashboard can be logged in with Google ID, Github or Facebook ( more login options like single login providers like OneLogin and login using StackOverflow / StackExchange network ID may also be added if needed in future ).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience(a feature of user groups could be added in future).
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be compulsory to view the documentation.'''
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* This will help in several ways:
::* If the user can’t read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repositories.
:* Sugarbot will keep track of the git repositories and issues being opened, and when a label ( like easy, medium, hard, GCI, GSoC etc. ) is being attached to them by the repo maintainer.
:* The bot will automatically reflect issues according to their labels within the corresponding group on the page(a part of our newcomer's guide).
:* If the newcomer wants to start contributing right away, he can view the list of issues label-wise and choose them according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:38:05Z

Pratul1997: /* Add Shortcuts */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information ( like email address, name, handles etc. ) and would allow him to easily share his work and/or collaborate with others.
::* The dashboard can be logged in with Google ID, Github or Facebook ( more login options like single login providers like OneLogin and login using StackOverflow / StackExchange network ID may also be added if needed in future ).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience(a feature of user groups could be added in future).
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be compulsory to view the documentation.'''
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* This will help in several ways:
::* If the user can’t read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:36:18Z

Pratul1997: /* Dashboard */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information ( like email address, name, handles etc. ) and would allow him to easily share his work and/or collaborate with others.
::* The dashboard can be logged in with Google ID, Github or Facebook ( more login options like single login providers like OneLogin and login using StackOverflow / StackExchange network ID may also be added if needed in future ).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience(a feature of user groups could be added in future).
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be compulsory to view the documentation.'''
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:33:25Z

Pratul1997: /* Abstract */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:30:39Z

Pratul1997: /* My Profile */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T15:25:06Z

Pratul1997: /* Abstract */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The goal is to help new developers to settle easily into the SugarLabs world and provide a centralized documentation portal.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the projects, their progress and performance. Their contribution could also be seen by the other users, earning them respect in the society.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T10:29:46Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T10:27:48Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] with [http://www.sphinx-doc.org/en/stable/theming.html classic] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Markdown would be utilized.
::* Only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* As discussed in the previous risk, [http://www.sphinx-doc.org/en/master/ sphinx] engine will be used to convert our markdown of sugardoc to HTML content of our dashboard's newcomer guide, Sphinx also provide the feature to covert the documentation in the pdf format.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.
::* As there is the only one source of newcomer documentation which is sugar doc and markdown is used there, so it will be easy for everyone to update it on Github repository.We will also add a page with the contributor on Sugar Doc where we can list the name of developers who contributed to Sugardoc and other projects. Also as it will be the only source documentation so the risk of "Rarely do new people begin to edit" is also removed. The developers can showcase their contribution on that page so it is sort of social reward for them by Sugarlabs.
::* As for the contributor who is not comfortable with Github, a part about getting started with Github will also be there in the newcomer guide. Link to basic syntax of https://www.markdowntutorial.com/ and [https://guides.github.com/activities/hello-world/ GitHub] and such links will also be there. There will also be badges when you complete this part. It will attract the contributor to learn Github and its task. After there learning they can also contribute to Sugarlabs through Github.
The root cause is that people vary in their comfort level with specific
tools or sources. For example, we still have a valuable contributor
who will not use GitHub no matter how hard we try to help them.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-20T07:39:38Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter].
::* I will try to bring the content of all these resources at a single place which would be sugardoc because we would be utilizing [http://www.sphinx-doc.org/en/master/ sphinx] to convert markdown to HTML, pdf format. We have another alternative to display content on our dashboard using [http://docs.readthedocs.io/en/latest/embed.html ReadtheDoc Embed] feature.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place and remove other resources of newcomer guide.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* I could take their feedback and improve the guide further. In case many students are facing the same problem, I’ll try to find the reason and resolve it.
::* After intensive testing during the tenure from that stater category of the developer, it will help the other new developers in an easy manner.
::* Further as the only markdown will be used as new-comer guide, other resources have been removed, so the community doesn't need to devote there work at different places instead they need to work on one place, and markdown is easily accessible by everyone.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T16:23:48Z

Pratul1997: /* Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and when some sort of labels like easy, medium, hard, GCI, GSoC is being attached to them by the repo maintainer.
:* This bot will automatically reflect issues according to the attached label on the web page, the part of our newcomer's guide.
:* Further if the newcomer wants to start contributing right away, he can view that list of issues of respective labels and choose his issues according to difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter]. I will try to recompile them and bring all the resources at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve the guide further, in case many students are facing the same problem.
::* It will also increase the number of contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T16:12:04Z

Pratul1997: /* Other Commitments */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and the easy, medium, hard, GCI, GSoC labels attached to them by the repo maintainer.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomer wants to start contributing right away, he can view that list and choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter]. I will try to recompile them and bring all the resources at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve the guide further, in case many students are facing the same problem.
::* It will also increase the number of contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have classes that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T16:11:26Z

Pratul1997: /* Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and the easy, medium, hard, GCI, GSoC labels attached to them by the repo maintainer.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomer wants to start contributing right away, he can view that list and choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
:::* [https://github.com/coala/corobo Corobo]
:::* [https://github.com/publiclab/plotsbot plotsbot]
::* For connection with IRC we will utilize [https://github.com/errbotio errbot]
: '''Skills Required:''' NodeJs, JSON, XML, Javascript or Python

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter]. I will try to recompile them and bring all the resources at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve the guide further, in case many students are facing the same problem.
::* It will also increase the number of contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T13:05:10Z

Pratul1997: /* Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and the easy, medium, hard, GCI, GSoC labels attached to them by the repo maintainer.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomer wants to start contributing right away, he can view that list and choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

====Information====

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter]. I will try to recompile them and bring all the resources at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve the guide further, in case many students are facing the same problem.
::* It will also increase the number of contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T11:53:17Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and the easy, medium, hard, GCI, GSoC labels attached to them by the repo maintainer.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomer wants to start contributing right away, he can view that list and choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter]. I will try to recompile them and bring all the resources at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve the guide further, in case many students are facing the same problem.
::* It will also increase the number of contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Further I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomer's guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T11:50:59Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and the easy, medium, hard, GCI, GSoC labels attached to them by the repo maintainer.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomer wants to start contributing right away, he can view that list and choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomer guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter]. I will try to recompile them and bring all the resources at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guide resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve the guide further, in case many students are facing the same problem.
::* It will also increase the number of contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period gets over. I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and keep working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Also I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomers guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T11:43:04Z

Pratul1997: /* Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of the git repositories and issues being opened, and the easy, medium, hard, GCI, GSoC labels attached to them by the repo maintainer.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomer wants to start contributing right away, he can view that list and choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Also I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomers guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T11:39:59Z

Pratul1997: /* Add Shortcuts */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability for the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part is important to keep bookmarked for future.
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Also I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomers guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T11:36:51Z

Pratul1997: /* Badge Feature in Dashboard */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged-in, he will be prompted to login so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Also I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomers guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T11:35:13Z

Pratul1997: /* Project Proposal Information */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===The Project===
====Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about their developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of the dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will be visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard whenever he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Also I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomers guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T07:16:25Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
:* Also I have divided the features by their “difficulty level” and “time requirement” and decided the sequence of implementation of features in each phase accordingly.
::* Brief description of each phase :
:::* '''Phase I: ''' During this phase, I’ll work on the features which can be implemented in less time and don’t involve too much complexity. This would include things like the dashboard feature and the newcomers guide.
:::* '''Phase II:''' This phase will consist of features which have medium difficulty and also one or two harder level features which require more time, such that implementing and testing the newcomers guide and improving it according to the feedback input. Emphasis would be made on testing the implemented features during this period. Dashboard for badges will also be incorporated during this phase.
:::* '''Phase III:''' During the final phase, I will devote my time mainly on the harder to implement features and the ones left out from Phase I and Phase II. I’ll again focus on making the newcomers guide even better, test it on different screen sizes like mobile phones, tablets, and computers, so as to make sure that it is responsive enough on all the types of devices. Will also work to add Sugarbot to the newcomer guide.
: {| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-18T04:16:20Z

Pratul1997: /* Current Status of Project */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
{| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T17:53:20Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
:* GSoC is typically about 12 weeks long, with an additional 25 days of community bonding period.
:* The evaluation is in three phases viz. Phase I, Phase II and Phase III. I have divided my workflow accordingly.
{| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T16:23:06Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
{| class="wikitable"
|-
! Time Frame !! Start Date - End Date !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T16:22:25Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
{| class="wikitable"
|-
! Time Frame !! Header text !! Task
|-
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies

Try to install those Sugar Labs project on my local machine

In case of any problem will try to contact the project maintainer
|-
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the

new students to work on them.Take feedback from students during GCI about

the current productivity of the dashboard and desirable new features

to the newcomer guide. Linking of data analysis of the dashboard and also,

add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T16:16:11Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
{| class="wikitable"
|-
! Time Frame !! Header text !! Task
|-
| Community Bonding || Example ||
Gather information about all SugarLabs project and their dependencies
|-
| || Example ||
Try to install those Sugar Labs project on my local machine
|-
| || Example ||
In case of any problem will try to contact the project maintainer
|-
| || Example ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || Example ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || May 14 - May 20 ||
Start making Dashboard
|-
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
|-
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
|-
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
|-
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || July 09 - July 15 ||
Cleanup of code and extensive testing
|-
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
|-
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the new students to

work on them.Take feedback from students during GCI about the current productivity of the

dashboard and desirable new features to the newcomer guide. Linking of data analysis of

the dashboard and also, add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T16:10:28Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
{| class="wikitable"
|-
! Time Frame !! Header text !! Task
|-
| Community Bonding || Example ||
Gather information about all SugarLabs project and their dependencies
|-
| || Example ||
Try to install those Sugar Labs project on my local machine
|-
| || Example ||
In case of any problem will try to contact the project maintainer
|-
| || Example ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| || Example ||
A lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
| Phase I || Example ||
Start making Dashboard
|-
| || Example ||
Addition Privacy feature to the dashboard
|-
| || Example ||
Start work on newcomers/beginners Guide
|-
| || Example ||
Use Bootstrap to make the beginner guide responsive
|-
| || Example ||
Add JQuery to make the newcomers guide more interactive
|-
| Phase II || Example ||
Remove extra components of Bootstrap and Jquery

(prepare the minimized bootstrap and JQuery) to make our website load faster

|-
| || Example ||
Start work on adding checkpoints after the suitable interval in the Guide.
|-
| || Example ||
Linking badge with the checkpoints so that when clicked the badges get

reflected in the user’s profile
|-
| || Example ||
Cleanup of code and extensive testing
|-
| Phase III || Example ||
Work on Sugarbot which looks for labels and adds them to its database
|-
| || Example ||
Making the layout of issue section in the website to list all issues at a single place
|-
| || Example ||
Integrating latest 10 issues on the website
|-
| || Example ||
Extensive testing of newcomer guide and Sugarbot
|-
| After GSoC || Example ||Keep contributing to Sugarlabs and updating the newcomer's guide

as the dependencies change or the project description changes.

Help others to contribute to and use Sugar Labs projects.

Work to improve and advance Sugarbot for a lot more automation.

Serve as GCI mentor for this the above listed new projects and guide the new students to

work on them.Take feedback from students during GCI about the current productivity of the

dashboard and desirable new features to the newcomer guide. Linking of data analysis of

the dashboard and also, add analysis of specific parts on which fewer badges were received.
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T15:55:58Z

Pratul1997: /* Timeline */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Beginner's Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''SugarLabs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. a platform for guiding them how to start contributing and taking care of FAQ’s like :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* Convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* Make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===
{| class="wikitable"
|-
! Header text !! Header text !! Task
|-
| Example || Example ||
Gather information about all SugarLabs project and their dependencies
|-
| Example || Example ||
Try to install those Sugar Labs project on my local machine
|-
| Example || Example ||
In case of any problem will try to contact the project maintainer
|-
| Example || Example ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
| Example || Example ||
Lot of discussions with the community, discussions with mentors

on an implementation of features whose reference links I was unable to find.

If my mentor thinks I am ready to start then I’ll start working on Phase I

|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|}

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T15:46:11Z

Pratul1997: /* My Profile */

Summer of Code/2018/Making a Beginner Guide

2018-03-17T05:17:48Z

Pratul1997: /* Proposal Abstract */

Summer of Code/2018/Making a Beginner Guide

2018-03-17T05:14:34Z

Pratul1997: /* Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot */

Summer of Code/2018/Making a Beginner Guide

2018-03-17T05:10:36Z

Pratul1997: /* Project and the community */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as for establishing ones to get all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they won't have to figure out all the procedures by themselves.
::* FAQ’s like “How to download Sugar labs projects” and “how to start contributing” would be taken care of at a single place in an organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users and changes would be made accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and of how much help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.

*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on DuckDuckGo, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.

*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I'll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:53:14Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The Open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Timeline===

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:52:26Z

Pratul1997: /* Add Shortcuts */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.
:* A button at the top right will be provided to integrate one-click easy shortcut addition to his dashboard.
'''Technologies used:''' Bootstrap, JavaScript, NodeJs, MongoDB

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:47:33Z

Pratul1997: /* Add Shortcuts */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* If the user feels some part of Beginner Guide is important for him and he is unavailable to work on that at that instant moment then he can add Shortcut to it.
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* As Bookmarks
::* To help other users to get started in the community in very quick manner.

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:38:50Z

Pratul1997: /* Project and the community */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on Github
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:35:48Z

Pratul1997: /* My Profile */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:35:10Z

Pratul1997: /* Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' [[pratulkumar1997@gmail.com]]
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* The open Source software [https://wkhtmltopdf.org/ wkhtmltopdf] will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:33:11Z

Pratul1997: /* My Profile */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' [[pratulkumar1997@gmail.com]]
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:30:52Z

Pratul1997: /* Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:30:20Z

Pratul1997: /* Other Commitments */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like [https://season.kde.org/?q=program_home&prg=46 Season of KDE dashboard] and certain other competitions like [https://lab.codingblocks.com/boss/ BOSS - Bountiful Open Source Summer]) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:24:15Z

Pratul1997: /* Badge Feature in Dashboard */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====
:* The documentation will be on the right side. The left side will contain navigation bar and links.
:* There would be a button at the end of each page so when the user has completed a certain portion of the documentation he can press the button to confirm the completion and the progress would be reflected on his dashboard as a badge(certain stars will appear on his profile).
:* Newcomers would be engaged in this and they would also be able to share their badges on social media. So this also adds to promotion and publicity of Sugarlabs.
:* The user could log in by pressing “Sign In” option and sign into his dashboard with his registered credentials.
:* In case the user is not logged, he will be prompted to log in so that the badge gets added to his account.

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like Season of KDE dashboard and certain other competitions like BOSS - Bountiful Open Source Summer) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:15:37Z

Pratul1997: /* Dashboard Features */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====
::* The Dashboard would contain user’s basic information (like email address, name, IRC name, Time zone, GitHub handle, social media handles etc.) so as to help him to easily share and collaborate with others.
::* The purpose of making dashboard is to make a newcomer feel closer to our community.
::* The dashboard can be logged in through single click integrated with Google ID, Github or Facebook (more login options like single login providers like OneLogin and log in using StackOverflow/StackExchange network ID may also be added if needed in future).
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
::* The user would be able to bookmark the articles of the guide or add them to “read later” for future reference and access them from his dashboard when he needs.
::* '''Login won’t be the compulsory part, the documentation can be viewed without even logging.'''
::* These features would be add-ons to the current idea of the Beginners Guide.
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
::* Nearly all the frameworks and libraries specified here are Open Source

====Badge Feature in Dashboard====

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like Season of KDE dashboard and certain other competitions like BOSS - Bountiful Open Source Summer) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:04:03Z

Pratul1997: /* My Profile */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Github:''' [https://github.com/Pratul1997 Pratul1997]
:'''Linkedin:''' [https://www.linkedin.com/in/pratul1997/ pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====

====Badge Feature in Dashboard====

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like Season of KDE dashboard and certain other competitions like BOSS - Bountiful Open Source Summer) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-17T04:01:34Z

Pratul1997: /* Sugarbot */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Github:''' https://github.com/Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Linkedin:''' https://www.linkedin.com/in/pratul1997/
:'''Facebook:''' https://www.facebook.com/Pratul1997
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====

====Badge Feature in Dashboard====

====Add Shortcuts====

====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* Sugarbot will keep track of repositories and when an issue is being opened, and the maintainer of the repo attaches easy, medium, hard, GCI, GSoC label to it on GitHub.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* So if the newcomers want to start contributing right away, the user can view those list and can choose his issues according to of difficulty level and required the skill set and start working.
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://github.com/nodejs/github-bot
::* To retrieve data from Developer Github API, JSON knowledge needed.
::* The inspiration of ideas are from to:
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]

: '''Skills Required:''' NodeJs, JSON, XML, Javascript

===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like Season of KDE dashboard and certain other competitions like BOSS - Bountiful Open Source Summer) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-16T18:28:49Z

Pratul1997: /* Counterpart the Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Github:''' https://github.com/Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Linkedin:''' https://www.linkedin.com/in/pratul1997/
:'''Facebook:''' https://www.facebook.com/Pratul1997
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====

====Badge Feature in Dashboard====

====Add Shortcuts====

====Sugarbot====
===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like Season of KDE dashboard and certain other competitions like BOSS - Bountiful Open Source Summer) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.

Summer of Code/2018/Making a Beginner Guide

2018-03-16T18:28:13Z

Pratul1997: /* Counterpart the Risks */

== Google Summer of Code 2018 Project Proposal ==

== Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot==

=== Mentors===
:'''Jaskirat Singh'''
:'''Hrishi Patel'''
:'''Rishabh Thaney'''
:'''Shivang Shekhar'''
:'''Samson Goddy'''
:'''Abdulazeez Abdulazeez'''

===My Profile===
:'''Name:''' Pratul Kumar
:'''University:''':The LNM Institute of Information and Technology
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Telephone:''' +91-8107525493
:'''IRC:''' Pratul1997
:'''Github:''' https://github.com/Pratul1997
:'''Sugar Labs wiki UserName:''' Pratul1997
:'''Linkedin:''' https://www.linkedin.com/in/pratul1997/
:'''Facebook:''' https://www.facebook.com/Pratul1997
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30

=== Open Source Contribution ===
:*'''Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?'''
: Yes I have been contributing to Open Source since September 2017.
:* '''Organisations''' :
::* [https://github.com/sugarlabs Sugarlabs]
::* [https://github.com/Cybros CybrosX] (Open-Source Organisation of my college Computer Club)
::* I am managing one Open-Source organization of my college.
:::* [https://github.com/MozLNMIIT MozLNMIIT]
::::* [https://github.com/MozLNMIIT/LNMHacks-2.0 LNMHacks 2.0 Website]( ''LNMHacks is the Hackathon conducted by LNMIIT in November'' )
::::* [https://github.com/MozLNMIIT/Pull-Request-and-Hacktoberfest Pull-Request-and-Hacktoberfest]( ''To promote Open Source Contribution during October'' )
:* '''My first Pull request:''' Removed Material CSS [https://github.com/goyal-sidd/lnmhacks/pull/14 #14]
:* Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

===Project Proposal Information===
====Proposal Abstract====
:* To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
::* Where to start?
::* What to start?
::* How to start?
::* Where to submit?

:* We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as '''sugarlabs.github.io'''
:* The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
:* To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

====Current Status of Project====

====Dashboard Features====

====Badge Feature in Dashboard====

====Add Shortcuts====

====Sugarbot====
===Counterpart the Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
::* Currently Sugar Labs has multiple newcomers guides in the forms of a book, [https://wiki.sugarlabs.org/go/Documentation_Team Sugar Wiki], and [https://github.com/sugarlabs/sugar-docs sugardoc], [https://wiki.sugarlabs.org/go/Google_Code_In_2017/background GCI Starter] I will try to recompile them and bring all the resource at a single place with proper inter-linking, It’ll facilitate proper navigation.
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* I have large student community at my college. I have a thought of organizing Sugar Labs online seminar, where we can guide them about Open Source contribution, and direct them to the newcomer guide.
::* So, it will provide me raw feedback from them and I can improve that guide further, in case many students are facing the same problem also it will increase more number of the contributors to sugarlabs.

* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* Basic Html 5 tags and CSS attributes will be utilized.
::* Throughout the development only open-source software and technologies like [https://github.com/twbs Bootstrap], [https://github.com/angular Angular], [https://github.com/nodejs NodeJs], [https://github.com/angular/material2 Material] etc will be used.
::* To convert Html files to markdown https://domchristie.github.io/turndown/
::* The open Source software https://wkhtmltopdf.org/ will be used to convert the completed website in a good layout pdf.
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.

* '''Risk [[#3]]; your beginner guide is abandoned soon after publishing'''
::* I want to work on this project even after GSoC period overs I see a huge possibility of exploration of Sugarbot and I will be always there for updation of the newcomer Guide and working on Sugarbot to make things automated and easy.

===Project and the community===
*'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
::* To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
::* Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
::* If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
*'''What will you do if you get stuck on your project and your mentor isn't around?'''
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
::* Read the documentation of the tool in which problem occurs.
::* Contact other SugarLabs members through IRC, developer mailing lists
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
*'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
::* Convey daily work to my mentors
::* Daily updates on IRC
::* I will keep posting updates on my work on the developer mailing as per requirements
::* I’ll update my weekly work on either Github or BitBucket
::* Keep my work well documented for the community.

===Other Commitments===
* '''Have you applied to other organization?''' No
* '''Do you have plans to have any other job or internship during this period?''' No
* '''Do you have any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
::* My current semester will end on 5th May and next semester will start on 27th July.
::* During the vacation time, I can fully devote my time to this project. After my next semester starts I can manage to work for at least 4-6 hours a day.
* '''Since when you have been part of the community?'''
::* I have been part of Sugarlabs community since October 2017.
::* I have also tried to serve as GCI mentor and guide new students, I will be part of Sugarlabs community even after completion of GSoC tenure.
::* I’ll try to keep on adding newer features and ideas to the project after GSoC as there are a few ideas in my mind ( like dashboard feature can be explored in the much better way in future like Season of KDE dashboard and certain other competitions like BOSS - Bountiful Open Source Summer) which can’t be implemented within the tenure of GSoC. I would like to work upon those ideas after GSoC.