90
edits
Changes
Summer of Code/2018/Making a Beginner Guide (view source)
Revision as of 13:03, 20 March 2018
, 13:03, 20 March 2018→Other Commitments
===My Profile===
===My Profile===
:'''Name:''' Pratul Kumar
:'''Name:''' Pratul Kumar
:'''University:''' The LNM Institute of Information and Technology
:'''University:''' [https://www.lnmiit.ac.in/ The LNM Institute of Information and Technology]
:'''Course:''' B.Tech. in Communications and Computer Engineering
:'''Course:''' B.Tech. in Communication and Computer Engineering
:'''Year:''' 2nd year (4th semester)
:'''Year:''' 2nd year (4th semester)
:'''Email:''' pratulkumar1997@gmail.com
:'''Email:''' pratulkumar1997@gmail.com
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Facebook:''' [https://www.facebook.com/Pratul1997 Pratul1997]
:'''Languages:''' English, Hindi
:'''Languages:''' English, Hindi
:'''Time-Zone:''' Jaipur , India UTC+5:30
:'''Time-Zone:''' Jaipur, India UTC+5:30 (Kolkata)
=== Open Source Contribution ===
=== Open Source Contribution ===
:* 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.
:* 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===
===The Project===
====Proposal Abstract====
====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 :
:* To make a beginners guide for SugarLabs, a platform to guide them to start contributing and to taking care of FAQ’s like :
::* <u>Where to start?</u>
::* <u>Where to start?</u>
::* <u>What to start?</u>
::* <u>What to start?</u>
::* <u>Where to submit?</u>
::* <u>Where to submit?</u>
:* 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'''
:* Convert the markdown and grasp the content from different current documentations and bring all that information to a single place.
:* The basic goal is to help new developers to settle easily into the SugarLabs world.
:* 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 developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.
:* 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.
====Dashboard Features====
::* 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 ).
::* 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.
::* 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.
::* 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).
::* '''Login won’t be compulsory to view the documentation.'''
::* These details would be shared as per the privacy settings of the user where he can decide what information will visible to which audience.
:* '''Technologies Used:''' NodeJS, JavaScript, Jquery, Bootstrap
::* 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.'''
:* '''Technologies Used:''' NodeJS, MongoDB, HTML, CSS, JavaScript, Jquery, Bootstrap, Material, Angular
====Badge Feature in Dashboard====
====Badge Feature in Dashboard====
:* 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.
:* 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.
:* 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.
:* 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====
====Add Shortcuts====
:* This feature is to ease the navigation and readability of the user.
:* This feature is to ease the navigation and readability for the user.
:* This will help in several ways:
:* This will help in several ways:
::* If the user cannot read some part at that moment.
::* If the user can’t read some part at that moment.
::* If he feels some part important to keep as easy navigation for future.
::* 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.
::* 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.
:* 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
'''Technologies used:''' Bootstrap, JavaScript, NodeJs
====Sugarbot====
====Sugarbot====
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repository.
:* I propose to integrate a bot, called SugarBot with Sugarlabs GitHub repositories.
:* 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.
:* 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.
:* This bot will automatically reflect it to the web page, the part of our newcomer's guide.
:* The bot will automatically reflect issues according to their labels within the corresponding group on the page(a 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.
:* 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:
:* Skills need to work and implement the Sugarbot concept:
::* https://developer.github.com/v3/issues/#list-issues
::* https://developer.github.com/v3/issues/#list-issues
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://starters.servo.org/ Mozilla Starter Pack]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
:::* [https://publiclab.github.io/community-toolbox/ Publiclabs First Timer issue]
::* Certain Featured bots who perform the similar tasks:
: '''Skills Required:''' NodeJs, JSON, XML, Javascript
:::* [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===
===Risks===
* '''Risk [[#1]]: your beginner guide does not help a beginner'''
* '''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.
::* 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].
::* Now instead of having multiple newcomer guides resources, we can add all the resources in one place.
::* 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 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.
::* 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'''
* '''Risk [[#2]]; Beginner guide conflicts with other information'''
::* Those formats will be used which are generally acceptable and maintained by everyone.
::* 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.
::* 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.
::* Sphinx also provides the feature to convert the documentation to pdf format.
::* To convert Html files to markdown [https://domchristie.github.io/turndown/ domchristie.github.io]
::* Remove information from the current existing guide and put the link to new guide at those places and linked properly for proper navigation.
::* 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'''
* '''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.
::* 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===
===Timeline===
{| class="wikitable"
:* 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 !! Header text !! Task
! Time Frame !! Start Date - End Date !! Task
|-
|-
| Community Bonding || Example ||
| Community Bonding || April 24 - April 30 ||
Gather information about all SugarLabs project and their dependencies
Gather information about all SugarLabs project and their dependencies
Try to install those Sugar Labs project on my local machine
Try to install those Sugar Labs project on my local machine
In case of any problem will try to contact the project maintainer
In case of any problem will try to contact the project maintainer
|-
|-
| || Example ||
| || May 1 - May 6 ||
Learn NodeJs in more depth which will be required for implementing the Sugarbot
Learn NodeJs in more depth which will be required for implementing the Sugarbot
|-
|-
| || Example ||
| || May 7 - May 13 ||
A lot of discussions with the community, discussions with mentors
A lot of discussions with the community, discussions with mentors
If my mentor thinks I am ready to start then I’ll start working on Phase I
If my mentor thinks I am ready to start then I’ll start working on Phase I
|-
|-
| Phase I || Example ||
| Phase I || May 14 - May 20 ||
Start making Dashboard
Start making Dashboard
|-
|-
| || Example ||
| || May 21 - May 27 ||
Addition Privacy feature to the dashboard
Addition Privacy feature to the dashboard
|-
|-
| || Example ||
| || May 28 - June 03 ||
Start work on newcomers/beginners Guide
Start work on newcomers/beginners Guide
|-
|-
| || Example ||
| || June 04 - June 10 ||
Use Bootstrap to make the beginner guide responsive
Use Bootstrap to make the beginner guide responsive
|-
|-
| || Example ||
| || June 11 - June 17 ||
Add JQuery to make the newcomers guide more interactive
Add JQuery to make the newcomers guide more interactive
|-
|-
| Phase II || Example ||
| Phase II || June 18 - June 24 ||
Remove extra components of Bootstrap and Jquery
Remove extra components of Bootstrap and Jquery
|-
|-
| || Example ||
| || June 25 - July 01 ||
Start work on adding checkpoints after the suitable interval in the Guide.
Start work on adding checkpoints after the suitable interval in the Guide.
|-
|-
| || Example ||
| || July 02 - July 08 ||
Linking badge with the checkpoints so that when clicked the badges get
Linking badge with the checkpoints so that when clicked the badges get
reflected in the user’s profile
reflected in the user’s profile
|-
|-
| || Example ||
| || July 09 - July 15 ||
Cleanup of code and extensive testing
Cleanup of code and extensive testing
|-
|-
| Phase III || Example ||
| Phase III || July 16 - July 22 ||
Work on Sugarbot which looks for labels and adds them to its database
Work on Sugarbot which looks for labels and adds them to its database
|-
|-
| || Example ||
| || July 23 - July 29 ||
Making the layout of issue section in the website to list all issues at a single place
Making the layout of issue section in the website to list all issues at a single place
|-
|-
| || Example ||
| || July 30 - August 05 ||
Integrating latest 10 issues on the website
Integrating latest 10 issues on the website
|-
|-
| || Example ||
| || August 06 - August 14 ||
Extensive testing of newcomer guide and Sugarbot
Extensive testing of newcomer guide and Sugarbot
|-
|-
| After GSoC || Example ||Keep contributing to Sugarlabs and updating the newcomer's guide
| After GSoC || ||Keep contributing to Sugarlabs and updating the newcomer's guide
as the dependencies change or the project description changes.
as the dependencies change or the project description changes.
Work to improve and advance Sugarbot for a lot more automation.
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
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.
|}
|}
* '''Do you have plans to have any other job or internship during this period?''' 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 any short-term commitment during this period?''' No
* '''Do you have Eoverlapclasses that overlap during this period?'''
* '''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.
::* My current semester exams are from 29<sup>th</sup> April to 5<sup>th</sup> 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.
::* 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?'''
* '''Since when you have been part of the community?'''