Changes

Jump to navigation Jump to search
2 bytes added ,  09:14, 29 March 2018
added link in about section
Line 1: Line 1: −
{{DISPLAYTITLE:WikiPort : Migration of wiki activity pages to git}}
+
== Page Under Development GO SLOW! ==
 +
This page is under heavy development, thus for the time being, please refer to the proposal in rich-formatting on  [https://docs.google.com/document/d/1mPd_SeUqeJF_yKWVEDFuzU7LWsnUFSbLdQQ44HvsYyA/edit?usp=sharing Google Docs]
   −
[[Category:2018 GSoC applications]]
  −
__FORCETOC__
  −
__NOEDITSECTION__
  −
__INDEX__
  −
This page is under heavy development, for the time being, please refer to the proposal in rich-formatting [https://docs.google.com/document/d/1mPd_SeUqeJF_yKWVEDFuzU7LWsnUFSbLdQQ44HvsYyA/edit?usp=sharing here]
      
[[File:Logo wikiport.png|frameless|center|WikiPort]]
 
[[File:Logo wikiport.png|frameless|center|WikiPort]]
 +
    
== About You ==
 
== About You ==
 
'''Name''' - Vipul Gupta<br />
 
'''Name''' - Vipul Gupta<br />
'''Email address''' - vipulgupta2048@gmail.com <br />   
+
'''Email address''' - [http://mailto:vipulgupta2048@gmail.com vipulgupta2048@gmail.com] <br />   
'''Blog Url''' -  www.mixstersite.wordpress.com  <br />
+
'''Blog Url''' -  [http://www.mixstersite.wordpress.com www.mixstersite.wordpress.com] <br />
'''Sugar Labs wiki username''' - Vipulgupta2048 <br />
+
'''Sugar Labs wiki username''' - [https://wiki.sugarlabs.org/go/User:Vipulgupta2048 Vipulgupta2048] <br />
 
'''IRC nickname''' - vipulgupta2048 <br />
 
'''IRC nickname''' - vipulgupta2048 <br />
'''Linkedin''' - vipulgupta2048
+
'''Linkedin''' - [http://www.linkedin.com/in/vipulgupta2048 vipulgupta2048] <br />
'''Github''' - vipulgupta2048
+
'''Github''' - [http://www.github.com/vipulgupta2048 vipulgupta2048] <br />
'''Twitter''' - vipulgupta2048 <br />
+
'''Twitter''' - [http://www.twitter.com/vipulgupta2048 vipulgupta2048] <br />
 
'''First language - English (Fluent) <br />  
 
'''First language - English (Fluent) <br />  
 
'''Located at, and what hours (UTC) do you tend to work''' - I am based out of New Delhi, India (+5.30 GMT). I am flexible with timings and can work for 3-5 hours everyday.  
 
'''Located at, and what hours (UTC) do you tend to work''' - I am based out of New Delhi, India (+5.30 GMT). I am flexible with timings and can work for 3-5 hours everyday.  
   −
 
+
'''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?'''
'''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?
  −
'''
   
Yes, I have participated and maintained many open-source projects. Also been contributing to other community and conference projects. Some of the links and description of those pages are as follows
 
Yes, I have participated and maintained many open-source projects. Also been contributing to other community and conference projects. Some of the links and description of those pages are as follows
   −
* First pull request on my college community’s website, ALiAS - Maintainer since 2016.
+
* [https://github.com/asetalias/asetalias.github.io/pull/52 First pull request] on my college community’s website, [http://www.github.com/asetalias ALiAS] - Maintainer since 2016.
* vipulgupta2048/opengisproj_mirror- Involved building a web app for real-time monitoring of pollution levels in rivers of India and to assess the impact on the health of people using the water from the river. The working repo is private, hence a public mirror for showcasing.  
+
* [https://github.com/vipulgupta2048/opengisproj_mirror vipulgupta2048/opengisproj_mirror]- Involved building a web app for real-time monitoring of pollution levels in rivers of India and to assess the impact on the health of people using the water from the river. The working repo is private, hence a public mirror for showcasing.  
* vipulgupta2048/scrape Scraping major news websites/outlets in India using Scrapy [Python] Managing the data flow by employing PostgreSQL. Finding fake news using Machine Learning with help of libraries (Word2vec)
+
* [https://github.com/vipulgupta2048/scrape vipulgupta2048/scrape] Scraping major news websites/outlets in India using Scrapy [Python] Managing the data flow by employing PostgreSQL. Finding fake news using Machine Learning with help of libraries (Word2vec)
* Fixed bugs, wrote blogs, added new features using HTML, CSS and JS for the official website of the premier conference on Python in India, PyCON India 2017 ( Here and here)  
+
* Fixed bugs, wrote blogs, added new features using HTML, CSS and JS for the official website of the premier conference on Python in India, PyCON India 2017 ([https://github.com/pythonindia/inpycon2017/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3Avipulgupta2048+is%3Amerged+sort%3Acreated-asc+ Here] and [https://github.com/pythonindia/inpycon-blog/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3Avipulgupta2048+is%3Amerged+sort%3Acreated-asc+ here])  
* gitlab/asetalias/Community-Connect [Ongoing]   
+
* [https://gitlab.com/asetalias/Community-Connect gitlab/asetalias/Community-Connect] [Ongoing]   
* Completed: Hacktoberfest Challenge;  Here.
+
* Completed: Hacktoberfest Challenge;  [https://hacktoberfestchecker.herokuapp.com/?username=vipulgupta2048 Here].
* Building and mentoring website development for Pyladies Delhi Chapter Pyladies-delhi-website   
+
* Building and mentoring website development for Pyladies Delhi Chapter [https://github.com/vipulgupta2048/Pyladies-delhi-website Pyladies-delhi-website]  
* Recent contribution: In Sugar Labs         
+
* Recent contribution: In Sugar Labs. Mentioned in the Miscellaneous section.        
   −
Along with this, Python Delhi User Group (PyDelhi) is a volunteer-driven organization comprising of Pythonistas, enthusiasts, who have a primary focus in Python. I help by volunteering and organizing meetups for them. <br />
+
Along with this, [http://meetup.com/pydelhi Python Delhi User Group] (PyDelhi) is a volunteer-driven organization comprising of Pythonistas, enthusiasts, who have a primary focus in Python. I help by volunteering and organizing meetups for them. <br />
I am a committee member of my college’s open source community. ALiAS (Amity Linux Assistance Sapience) We conduct hands-on workshops, seminars, talks and much more to try and help as many people as we can along the process and motivate them to make their first PR.<br />
+
I am a committee member of my college’s open source community. [http://www.asetalias.in ALiAS (Amity Linux Assistance Sapience)] We conduct hands-on workshops, seminars, talks and much more to try and help as many people as we can along the process and motivate them to make their first PR.<br />
I genuinely love spreading knowledge among peers/juniors/underprivileged children wherever I can through my voice (Talks and workshops) and my words (Tech-Blog)
+
I genuinely love spreading knowledge among peers/juniors/underprivileged children wherever I can through my voice ([https://github.com/asetalias/Logistics-and-Event-Contributions/issues?q=is%3Aissue+author%3Avipulgupta2048+is%3Aclosed Talks] and [https://github.com/ILUGD/talks/issues?q=is%3Aissue+author%3Avipulgupta2048+is%3Aclosed workshops]) and my words ([http://www.mixstersite.wordpress.com Tech-Blog])
      Line 56: Line 51:  
# '''Size issues''' - Wiki is being hosted on the a server. With the growing number of activities, the size occupied by them will increase leading to rise in maintenance cost. Not to mention buying more space.  
 
# '''Size issues''' - Wiki is being hosted on the a server. With the growing number of activities, the size occupied by them will increase leading to rise in maintenance cost. Not to mention buying more space.  
 
# '''No clear format/classification''' - Some links are for one activity only while other activities have multiple links for them (example Turtle Art) Results in time being wasted of the user even if they are justified.  
 
# '''No clear format/classification''' - Some links are for one activity only while other activities have multiple links for them (example Turtle Art) Results in time being wasted of the user even if they are justified.  
Found 2 wiki pages of the same activity. (this page and this too)
+
- Found 2 wiki pages of the same activity. (this page and this too)
I did extensive research on the same and found many such problems with the wiki. According to my experience in open-source, users just need information fast, easily accessible and neatly organized.  
+
I did extensive research on the same and found many such problems with the wiki. According to my experience in open-source, users just need information fast, easily accessible and neatly organized. <br />
 
A new method to make that information organized should be brought in place for the betterment of the whole community. GitHub could be the solution to all our problems (Check here for reference) WikiPort is a tool that helps in migration process of wiki’s to Github hosted README.md.  
 
A new method to make that information organized should be brought in place for the betterment of the whole community. GitHub could be the solution to all our problems (Check here for reference) WikiPort is a tool that helps in migration process of wiki’s to Github hosted README.md.  
 
   
 
   
Objective  
+
'''Objective''' <br />
 
To migrate documentation and information of each activity in Activities#Sugar_Activities of Sugar Labs in MediaWiki format to their respective git repositories hosted on GitHub in rich markdown format by a program/tool with special attention to the transfer of all information and media associated with the activity with least redundancies and zero duplication of content if not already present in GitHub@README.md or user documentation in help-activity.
 
To migrate documentation and information of each activity in Activities#Sugar_Activities of Sugar Labs in MediaWiki format to their respective git repositories hosted on GitHub in rich markdown format by a program/tool with special attention to the transfer of all information and media associated with the activity with least redundancies and zero duplication of content if not already present in GitHub@README.md or user documentation in help-activity.
 
   
 
   
Technologies and Skills Used
+
'''Technologies and Skills Used''' <br />
 
This list is just a small glimpse of technologies that I am thinking to use for this project. I am proficient in each of them, through my past projects. (Refer)   
 
This list is just a small glimpse of technologies that I am thinking to use for this project. I am proficient in each of them, through my past projects. (Refer)   
'''Programming Language''': Python 3.6 using libraries such as requests, LXML, Scrapy, Beautifulsoup etc. Python will be used widely in this project.  
+
* '''Programming Language''': Python 3.6 using libraries such as requests, LXML, Scrapy, Beautifulsoup etc. Python will be used widely in this project.  
'''Markup Languages''' - Markdown, MediaWiki, reStructuredText
+
* '''Markup Languages''' - Markdown, MediaWiki, reStructuredText
'''For Automation''' - Ansible or Bash (To automate each step of the migration process and installation of the tool.)
+
* '''For Automation''' - Ansible or Bash (To automate each step of the migration process and installation of the tool.)
'''Tools''' - git, shell, MediaWiki API - Pywikibot,GitHub API (Experimental)  
+
* '''Tools''' - git, shell, MediaWiki API - Pywikibot,GitHub API (Experimental)  
'''Others''' - Yaml (If Ansible is used)  
+
* '''Others''' - Yaml (If Ansible is used)  
   −
An Overview of the Migration Process   
+
== An Overview of the Migration Process ==  
    
[[File:S.U.G.A.R.png|thumb|center]]
 
[[File:S.U.G.A.R.png|thumb|center]]
   −
Some documentation of activities are stored in help-activity. Hence to prevent duplication of content between these two sources (Wiki and help-activity), my checklist already contains a step to either manually check the content difference between them or use a script or program to find and settle differences between them. Thus ensuring end-to-end migration of the wiki-pages and avoiding more maintenance.   
+
'''Detailed Description of the steps mentioned '''
We can also help keep the help-activity updated by using GitHub’s API for pull requests which can comment the link of the specific help-activity page if anyone submits a PR to change README.md of the activity. (Experimental - but can be implemented)
+
 
Detailed Description of the steps mentioned  
+
'''One time task''' - Use a spider to scrape GitHub links for each activity in a proper JSON format (with names of each activity). IF GitHub links not found for the repository, then scripts throws back exception and then links can be found manually.  
One time task - Use a spider to scrape GitHub links for each activity in a proper JSON format (with names of each activity). IF GitHub links not found for the repository, then scripts throws back exception and then links can be found manually.  
+
 
Step 0  
+
*'''Step 0 ''' -Extracting content; from these methods that offers the least redundancies. My research yielded these results.
Extracting content; from these methods that offers the least redundancies. My research yielded these results.
+
1. Query MediaWiki API and acquire content in wikitext format
1. Query MediaWiki API and acquire content in wikitext format
+
2. Export pages in XML using Python Wikipedia Robot Framework   
2. Export pages in XML using Python Wikipedia Robot Framework   
+
3.  GET page in simple HTML ( Activities/Sugar_Network&printable=yes)  
3.  GET page in simple HTML ( Activities/Sugar_Network&printable=yes)  
+
*'''Step 1'''Convert the data sourced from step 0; using Pandoc to Markdown. Removing syntax, comments and Wikimedia code that might be left after conversion using regex wherever required.   
Step 1
+
* Step 2
Convert the data sourced from step 0; using Pandoc to Markdown. Removing syntax, comments and Wikimedia code that might be left after conversion using regex wherever required.   
  −
Step 2
   
Fork and clone the respective GitHub repository from the links already scraped or found manually of the activity   
 
Fork and clone the respective GitHub repository from the links already scraped or found manually of the activity   
 
Step 3
 
Step 3
Line 100: Line 93:       −
 
+
== Project Deliverables ==
Important Note
+
# 345 web pages stored in MediaWiki format atActivities#Sugar_Activities on Sugar Labs Wiki converted to Markdown format with assets (images and other files) intact and in-place with zero duplication.   
I noticed by the pull requests of my fellow contributors on Sugar Labs Github have yielded unnecessarily large activity bundles which might be an issue. As one always aims to keep the repository size as small as possible. This needs to be taken care of.
+
# Files in Markdown converted from the wiki content are tested and checked to ensure foolproof 100% migration without any redundancies or loss of information. Manually or through scripts.
The fix I propose is to add these said bundles to gitignore by implementing a test case for or a python script to exclude them.
+
# A detailed report with classified information about the Sugar_activities wiki that needs further improvements submitted to Sugar Labs (Refer week #8 in timeline #Wikiteam)
 
+
Files committed, pushed and PR’s made in each activity’s respective git repository in an information specific format for easy reference.  
Project Deliverables
+
# Tested bug-free source code for everyone to use (and other open source projects) for their wikis facing the same issues. Complete documentation of the migration method submitted on time of evaluations with the review of the mentor incorporated.
345 web pages stored in MediaWiki format atActivities#Sugar_Activities on Sugar Labs Wiki converted to Markdown format with assets (images and other files) intact and in-place with zero duplication.   
+
# After the complete transfer of all the wiki content, discuss and implement the last actions on the wiki, to either delete the pages or link them back to their respective git repositories.   
Files in Markdown converted from the wiki content are tested and checked to ensure foolproof 100% migration without any redundancies or loss of information. Manually or through scripts.
  −
A detailed report with classified information about the Sugar_activities wiki that needs further improvements submitted to Sugar Labs (Refer week #8 in timeline #Wikiteam)
  −
Files committed, pushed and PR’s made in each activity’s respective git repository in a information specific format for easy reference.  
  −
Tested bug-free source code for everyone to use (and other open source projects) for their wikis facing the same issues. Complete documentation of the migration method submitted on time of evaluations with the review of the mentor incorporated.
  −
After the complete transfer of all the wiki content, discuss and implement the last actions on the wiki, to either delete the pages or link them back to their respective git repositories.
  −
  −
Thus, by the deliverables mentioned above, 3 well defined goals that determines project status which will help in evaluation i.e
  −
Evaluation 1: Migration of 100 wiki-pages complete; 
  −
Evaluation 2: Migration of 300 wiki-pages complete; 
  −
Final: Migration of 345 wiki-pages;
  −
   
   
   
 
   
 +
'''Thus, by the deliverables mentioned above, 3 well-defined goals that determine project status which will help in evaluation i.e'''<br />
 +
Evaluation 1: Migration of 100 wiki-pages complete;<br /> 
 +
Evaluation 2: Migration of 300 wiki-pages complete;<br /> 
 +
Final: Migration of 345 wiki-pages;<br />
 
   
 
   
Other Deliverables (and Future Work)
+
== Other Deliverables (and Future Work) ==
Contribute more - After and during the project, will help in solving bigger challenges and bugs faced as my experience lies in DevOps tasks and start reading code of Sugarizer.
+
# '''Contribute more''' - After and during the project, will help in solving bigger challenges and bugs faced as my experience lies in DevOps tasks and start reading code of Sugarizer.
Add Features - Edit history of wikis that are being migrated by WikiPort can be exported as commits on GitHub (implementing this).   
+
# '''Add Features''' - Edit history of wikis that are being migrated by WikiPort can be exported as commits on GitHub (implementing this).   
Create New Activities - Being well versed in Python (tried making a game with pygame) Would enjoy the new learning curve as I never really explored GTK. Have some new ideas that could be later transformed into fun, interactive learning activities.
+
# '''Create New Activities''' - Being well versed in Python (tried making a game with pygame) Would enjoy the new learning curve as I never really explored GTK. Have some new ideas that could be later transformed into fun, interactive learning activities.
Complete Misc. Tasks - Wiki pages contain task waiting to be completed I would like to volunteer and finish them for the welfare of the community like this one here IRC#Wishlist.
+
# '''Complete Misc. Tasks''' - Wiki pages contain task waiting to be completed I would like to volunteer and finish them for the welfare of the community like this one here IRC#Wishlist.
Remain as an active contributor for Sugar Labs and take part in discussions for the future projects. Maybe if the community agrees, also mentor someone myself in the foreseeable future.
+
# Remain as an '''active contributor for Sugar Labs''' and take part in discussions for the future projects. Maybe if the community agrees, also mentor someone '''myself''' in the foreseeable future.
Use Automation to our favor so that many tasks are completed in WikiPort using bash or Ansible scripts like environment setups, installation and fine workings of the entire tool. (Aim - one command to work it all out with the least number of user interventions)
+
# Use Automation to our favor so that many tasks are completed in WikiPort using bash or Ansible scripts like environment setups, installation and fine workings of the entire tool. (Aim - one command to work it all out with the least number of user interventions)
 
“WikiPort converts all MediaWiki documents to rich markdown format and commit them to GitHub or other hosting services without losing any of your data. A tool created by Sugar Labs with love.”  
 
“WikiPort converts all MediaWiki documents to rich markdown format and commit them to GitHub or other hosting services without losing any of your data. A tool created by Sugar Labs with love.”  
 
This seems to me like an excellent repository description of an awesome tool.
 
This seems to me like an excellent repository description of an awesome tool.
Line 132: Line 118:  
WikiPort feels likes that chance.   
 
WikiPort feels likes that chance.   
 
   
 
   
+
== Timeline ==
  −
  −
  −
  −
  −
What is the timeline for development of your project?
  −
Description as follows in accordance with the official timeline.
  −
 
  −
Date
  −
Event
  −
April 16
  −
Exams start (College)
  −
April 23
  −
Student Proposals announced.
  −
-*-*-*-*-*-  Community Bonding Period  -*-*-*-*-*-
  −
May 14
  −
Official Coding Day starts (Summer break starts)
  −
June 11
  −
First Evaluations
  −
July 9
  −
Second Evaluations
  −
19 July
  −
Soft Deadline [Pencil’s Down]
  −
23 July
  −
Hard Deadline [Final code review/ Bug fixing]
  −
August 6
  −
Submit Code and Final Evaluations
  −
 
  −
In accordance with the official timeline by GSoC, my college exams end somewhere in the first week of May or so. My college reopens early in July. During this time, I will remain in contact with my mentor.
  −
This gives me ample time to code. I plan to begin coding before the official period coding period of GSoC starts from starting of May. Which gives me a head start to finish the majority (80%) of the project before the second evaluation.
  −
Providing a total of 10 weeks to write code for WikiPort (& other deliverables)
  −
I will also write a weekly or Bi-weekly blog post on my progress and updates on my project and post it diligently on the website to get the community involved.  The Weekly timeline is as follows.
  −
 
  −
 
  −
 
  −
Task
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
  −
 
      +
* In accordance with the official timeline by GSoC, my college exams end somewhere in the first week of May or so. My college reopens early in July. During this time, I will remain in contact with my mentor.
 +
* This gives me ample time to code. I plan to begin coding before the official period coding period of GSoC starts from starting of May. Which gives me a head start to finish the majority (80%) of the project before the second evaluation.
 +
'''Providing a total of 10 weeks to write code for WikiPort (& other deliverables)'''
 +
* I will also write a weekly or Bi-weekly blog post on my progress and updates on my project and post it diligently on the website to get the community involved.  The Weekly timeline is as follows.
    
{| class="wikitable"
 
{| class="wikitable"
Line 203: Line 142:  
Continue with Research Part 2
 
Continue with Research Part 2
 
Finding, testing, implementing solutions available for Migration Process step 0 through 6.   
 
Finding, testing, implementing solutions available for Migration Process step 0 through 6.   
Discuss results with mentor, shortlist methods that have the highest success rate.  
+
Discuss results with the mentor, shortlist methods that have the highest success rate.  
 
Pushing to Github; fixing organization problems
 
Pushing to Github; fixing organization problems
 
|-
 
|-
Line 217: Line 156:  
Start work on migration script.  
 
Start work on migration script.  
 
Test migration script on 10 activities (aim - 60% migration of content from wiki to GitHub readme of the activity)
 
Test migration script on 10 activities (aim - 60% migration of content from wiki to GitHub readme of the activity)
Gets reviewed by mentor; implement suggestions
+
Gets reviewed by the mentor; implement suggestions
      Line 298: Line 237:     
'''Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. ''' <br />
 
'''Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. ''' <br />
* I love writing and reading code. I learned almost everything by reading the docs. I, later on, started writing documentation and code for others too. Helping me always know exactly where I can find the information I am looking for and how to improve on it, how necessary it is.   
+
* I love writing and reading the code. I learned almost everything by reading the docs. I, later on, started writing documentation and code for others too. Helping me always know exactly where I can find the information I am looking for and how to improve on it, how necessary it is.   
* All my past projects, showcase a strong dedication to the deadline and the determination to get work done. WikiPort will be no different.   
+
* All my past projects, showcase a strong dedication to the deadline and the determination to get work done. WikiPort will be no different.   
 
* As for my skills, <br />
 
* As for my skills, <br />
 
- Articles written, published using Pelican, Wordpress (Markdown).<br />
 
- Articles written, published using Pelican, Wordpress (Markdown).<br />
 
- I use git in all project that I start. Document and collaborate on GitHub. <br />
 
- I use git in all project that I start. Document and collaborate on GitHub. <br />
 
- Comfortable with both Linux and Windows OS, (preferring Linux all the way) <br />
 
- Comfortable with both Linux and Windows OS, (preferring Linux all the way) <br />
 +
- Since Python is used widely, my previous project justify my experience and skill in the language <br />
 
- There is no better to prove that I can accomplish and execute my vision for WikiPort by actually showing that work has been done. (here) <br />
 
- There is no better to prove that I can accomplish and execute my vision for WikiPort by actually showing that work has been done. (here) <br />
 
- There are many points to keep in mind while migrating is taking place, hence for a '''more methodical''' approach a [https://etherpad.net/p/Sugar_Migration_Checklist checklist] has been implemented by me which has a summary of all the - steps. (Both manual/automated) <br />
 
- There are many points to keep in mind while migrating is taking place, hence for a '''more methodical''' approach a [https://etherpad.net/p/Sugar_Migration_Checklist checklist] has been implemented by me which has a summary of all the - steps. (Both manual/automated) <br />
 
   
 
   
You and the community
+
== You and the community ==
If your project is successfully completed, what will its impact be on the Sugar Labs community?
+
'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''<br />
If WikiPort is completed and deployed as a tool through this project. It would help in making the work easier for developers to not just Sugar Labs but everybody and even experienced users.  
+
*If WikiPort is completed and deployed as a tool for this project. It would help in making the work easier for developers to not just Sugar Labs but everybody and even experienced users.  
WikiPort will help users port their wikis to GitHub with minimum user inputs, which  would ultimately benefit everyone involved and for many generations of developers to come who will use that documentation.
+
*WikiPort will help users port their wikis to GitHub with minimum user inputs, which  would ultimately benefit everyone involved and for many generations of developers to come who will use that documentation.
As previously stated, documentation is an important part of any development process. Bad documentation impacts the entire community as. But if the documentation is
+
*As previously stated, documentation is an important part of any development process. Bad documentation impacts the entire community as. But if the documentation is
Accessible - GitHub is one of the best places to host it.  
+
1. '''Accessible''' - GitHub is one of the best places to host it.  
Relevant and easily traversable - The documentation about every activity will be housed with its GitHub Repository.   
+
2. '''Relevant and easily traversable''' - The documentation about every activity will be housed with its GitHub Repository.   
 
Clearly written - Strict format to maintain overall uniformity.  
 
Clearly written - Strict format to maintain overall uniformity.  
Easily editable (+ VCS) - Wiki offers edit history of documents too, but the process to edit a document is cumbersome while GitHub makes it very easy for users to fix issues in it.  
+
3. '''Easily editable (+ VCS)''' - Wiki offers edit history of documents too, but the process to edit a document is cumbersome while GitHub makes it very easy for users to fix issues in it.  
More views, more stars - GitHub also increases views and popularity of the activity ultimately helping Sugar Labs to get noticed more.
+
4. '''More views, more stars''' - GitHub also increases views and popularity of the activity ultimately helping Sugar Labs to get noticed more.
 
If our documentation has all these features, then everybody would be more inclined towards contributing to Sugar Labs and get to know more about it.   
 
If our documentation has all these features, then everybody would be more inclined towards contributing to Sugar Labs and get to know more about it.   
 
People would contribute more to bug fixing, indirectly helping the Sugar Labs community to grow and expand more. Helping students, developers, activity maintainers, members of the community.
 
People would contribute more to bug fixing, indirectly helping the Sugar Labs community to grow and expand more. Helping students, developers, activity maintainers, members of the community.
Line 354: Line 294:  
[https://github.com/sugarlabs/i-can-read-activity/pull/6 /i-can-read-activity/pull/6]  
 
[https://github.com/sugarlabs/i-can-read-activity/pull/6 /i-can-read-activity/pull/6]  
    +
Another Issue that I am currently working  is [https://github.com/sugarlabs/sugar-live-build/issues/6 sugar-live-build/issues/]
   −
Another Issue that I am currently working  is sugar-live-build/issues/
+
'''Describe a great learning experience you had as a child.'''
Describe a great learning experience you had as a child.
   
Here’s a short story titled “Let me Google that for you.” when I was 14.  
 
Here’s a short story titled “Let me Google that for you.” when I was 14.  
   Line 369: Line 309:  
* I learned a lot through these few weeks, working on the proposal. MediaWIki API and new skills, contributing to an open-source organisation of this stature, how to interact with people. This has been a memorable experience. I am in awe, I really am.
 
* I learned a lot through these few weeks, working on the proposal. MediaWIki API and new skills, contributing to an open-source organisation of this stature, how to interact with people. This has been a memorable experience. I am in awe, I really am.
 
* All open-source communities may not be same, but are run on the same principle that I also try to follow in life. Be humble, and helpful to everybody. The ‘ahaa-moment’ of a beginner is what I live for, when he truly get the point that I am trying to make.
 
* All open-source communities may not be same, but are run on the same principle that I also try to follow in life. Be humble, and helpful to everybody. The ‘ahaa-moment’ of a beginner is what I live for, when he truly get the point that I am trying to make.
* Some Credits - Learned to not contest for issues, but focus on better PR’s, and many new things from James Cameron (@Quozl)’s blog. Jasikrat too for helping people on IRC and all mentors who review our proposal and go through all our mails. Thank you all for the opportunities and the help provided to me and my fellow contributors. I hope down the line, I could follow in your footsteps too.
+
* Some Credits - Learned to not contest for issues, but focus on better PR’s, and many new things from James Cameron (@Quozl)’s blog. Jasikrat too for helping people on IRC emailsll mentors who review our proposal and go through all our mails. Thank you all for the opportunities and the help provided to me and my fellow contributors. I hope down the line, I could follow in your footsteps too.

Navigation menu