Summer of Code/2018/Making a Beginner Guide: Difference between revisions

(4 intermediate revisions by the same user not shown)

Line 68:

====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 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~~, MongoDB~~

'''Technologies used:''' Bootstrap, JavaScript, NodeJs

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

:* 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 issues according to the ~~attached label~~ on 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).

:* ~~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.

:* 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

Line 93:

Line 92:

::* 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.

::* 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 ~~and remove~~ other resources of newcomer guide.

::* 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.

~~::* 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 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.

::* 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.

::* 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.

::* ~~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.

::* 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 ~~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.

::* 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 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.

Line 237:

Line 233:

* '''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.

::* 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.

* '''Since when you have been part of the community?'''

@@ Line 68: / Line 68: @@
 ====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 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, MongoDB
+'''Technologies used:''' Bootstrap, JavaScript, NodeJs
 ====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 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.
+:* 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 issues according to the attached label on 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).
-:* 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.
+:* 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
@@ Line 93: / Line 92: @@
 ::* 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.
+::* 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 and remove other resources of newcomer guide.
+::* 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.
-::* 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 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.
-::* 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.
+::* 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.
-::* 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.
+::* 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 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.
+::* 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 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.
@@ Line 237: / Line 233: @@
 * '''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.
+::* 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.
 * '''Since when you have been part of the community?'''