154
edits
Changes
Jump to navigation
Jump to search
Summer of Code/2018/attentive migration of wiki activity pages to git (view source)
Revision as of 16:03, 13 March 2018
, 16:03, 13 March 2018Draft Version 1.0
= Google Summer of Code 2018 Project Proposal=
''Note: This is a work in progress. The proposal will be further modified and improved, upon discussions and feedback from the Sugar Labs community''
== Project Name: Attentive Migration of wiki activity pages to git ==
== Author : Rudra Sadhu ==
=== About Me ===
:'''Name:''' Rudra Sadhu
:'''Email:''' [mailto:rdrsadhu@gmail.com rdrsadhu@gmail.com]
:'''Sugar Labs wiki username:''' rdrsadhu (user-page at [[User: rdrsadhu]])
:'''IRC nickname on irc.freenode.net:''' rdrsadhu
:'''Languages:''' English, Hindi, Bengali
:'''Where am I located? and what hours(UTC) do I tend to work?'''
:* I'm located at Kolkata, India (UTC +05:30)
:* Working Hours: Flexible (Whatever works for both me and my mentor)
:'''Past experiences with Open-Source projects:'''
:* actively contributing to Open-Source since August, 2017
:* organisation: [https://github.com/oppia Oppia]
::* firstly, Why Oppia(and now Sugar Labs)?
:::: I've always believed, '' 'there is no process as powerful as education to change the world' ''
:::: Mission of Oppia Foundation and Sugar Labs are similar(if not exactly same). Read [http://oppiafoundation.org/mission/ here]
::* My first pull request : [https://github.com/oppia/oppia/pull/3743 Fix #3258: Add share-to-classroom Button] ''~Happiness is when pull-requests gets merged :)''
::* What else did I chip in?
:::* while playing around, Found an issue in the application,
:::: Recorded it : [https://github.com/oppia/oppia/issues/3750 https://github.com/oppia/oppia/issues/3750]
:::: Submitted fix: [https://github.com/oppia/oppia/pull/3754 https://github.com/oppia/oppia/pull/3754] ''~Felt Awesome!''
:::* Created outline for Mathematics Lessons(Geometry)
:::* 6 other Merged pull-requests. Complete list [https://github.com/oppia/oppia/pulls?q=is%3Apr+author%3ARdrsadhu+is%3Amerged+sort%3Acreated-asc here]
::::: these are either [https://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] (which proves my skill to understand complex codebases, and knowledge of intermediate git workflow- dealing with branches, merge-conflicts etc)
::::: or Trivial Documentation fixes (which confirms my attention to detail)
:* '''What did I gain out of contributing to Open Source projects and why I'm again up for it?'''
::* I learned a lot! and more importantly, had fun learning.
::* A sense of pride and satisfaction, to be able to contribute for a good cause, which impacts people around the globe.
::* Mentions on the [https://www.oppia.org/about#credits Credits Page]. Even if I die tomorrow, this will stay on.
::* I've got nothing to lose :D
:* I've tasted failures as well, and I'm not uncomfortable to talk about them. Well, because they often teach us a lot more than successes.
:: [https://github.com/oppia/oppia/pull/3924 this] pull-request of mine did not get merged.
=== About Project ===
:'''Project Name:''' <u>Attentive</u> Migration of wiki activity pages to git
:'''Description:'''
::* At present, the [[Activities#Sugar_Activities]] section in Sugar Labs wiki lists 345 pages.
::* These pages individually serves as homepages(containing all relevant information), for different Sugar Activities.
::: example: [[Activities/MakeyMakey]] is the homepage for [http://activities.sugarlabs.org/en-US/sugar/addon/4729 MakeyMakey] activity. Whereas, its source-code is hosted at [https://github.com/sugarlabs/makeymakey https://github.com/sugarlabs/makeymakey]
::* With every new activity, the volume of wiki.sugarlabs.org is expanding, and thus it is getting harder to maintain all of the stuff at a single place.
::* Also, as Sugar Labs is moving towards GitHub style of development (see [http://lists.sugarlabs.org/archive/sugar-devel/2018-January/055005.html discussion])
::: it would be beneficial(and more maintainable) in the long run if these 345 wiki pages were embedded in their corresponding git repositories.
:'''Objective:'''
::Write a program(or script) to migrate all of the above-mentioned wiki-content to their corresponding git repositories in markdown format, with great attention to quality.
:'''Promised Outcome:'''
::100% of mentioned wiki-pages(from wikitext markup) moved to their git repositories(in markdown format).
::*Something like [https://github.com/rdrsadhu/portfolio-activity https://github.com/rdrsadhu/portfolio-activity], from [[Activities/Portfolio]]
::**'' this is a fork of the original repository [https://github.com/sugarlabs/portfolio-activity https://github.com/sugarlabs/portfolio-activity]
::**'' I'm aware that the README.md file is not optimal.
::***'' I intend to discuss a few things with the community, before starting to optimize the conversion process, which will be the most important part of this project.''
::Also, all the current wiki-pages will be deprecated(deleted/moved? to be discussed with the community)
:'''Technologies used:'''
::* Programming Languages: Python 3.6
::* Tools: [https://git-scm.com/ git], [https://pandoc.org/ pandoc]
::* APIs: [https://www.mediawiki.org/wiki/API:Main_page MediaWiki API]
:'''High-Level overview of the Migration Process:'''
::For each page to migrate
::* Step 0: Determine to which GitHub repository, it'll be added
::* Step 1: from wiki.sugarlabs.org/activities/activity_page, Get source file(wikitext) which is to be converted(to markdown)
::* Step 2: Get associated extra files(images etc) used in the wiki-page
::* Step 3: Convert wikitext content to Markdown
::* Step 4: Add Converted Markdown files to GitHub repository mentioned in Step 0
::* Step 5: Delete/Archive wiki-page and associated extra files from wiki.sugarlabs.org
:'''Detailed Technical description of Migration Process'''
:* Step 1: using MediaWiki API, query wiki.sugarlabs.org to get list of all pages to convert
:* Step 2: For each page, research and find out(or discuss with mentor/community) where to place them in GitHub
:**''there isn't a one:one correspondence for all the pages and the git repositories''
:**''for example:''
:***''in the section [[Activities#Sugar_Activities]], there are at least 20 pages as Activities/Turtle Art/Tutorials/wiki-page-name , which I believe should be in the same git repository
:***''Some git repositories already has a README.md file, which contains information not available in the corresponding wiki-page (See [https://github.com/sugarlabs/Measure activity-git-repo] : [https://wiki.sugarlabs.org/go/Activities/Measure activity-wiki-page])
:***''The variety is a lot more, which I plan to extensively discuss, before the coding-period starts.
:* Step 3: For each GitHub repository to push converted markdown files:
:** 3.1: Fork the repository (create a copy of the original repository into my-GitHub-account)
:** 3.2: Pull the forked repository (get a local copy of it, in my development machine)
:** 3.3: For each file to be pushed into the repository:
:*** Using MediaWiki API, query a specific wiki-page, to get its raw source(in wikitext format), and all associated files(images etc)
:*** create a safe backup of the original raw wikitext
:*** generate one temporary duplicate file(containing raw wikitext), to convert into markdown format
:*** using pandoc, convert
:*** while the conversion is not perfect (it is difficult or sometimes not-possible, to generate the exact functionalities of a wiki-page into a markdown file. For example, image-galleries)
:**** modify the temporary wikitext file, with attention to every small detail
:**** and convert again
:** 3.3: Commit all newly generated files (also the safe wikitext backup; in-case the community decides to keep it for future reference)
:** 3.4: git push to Forked Repository
:** 3.5: Send a Pull Request to original Repository
:** 3.6: After Pull Request gets merged;
:*** redirect the wiki-page to its git repository
:*** using MediaWiki API, delete/move contents of original wiki-page
:'''Project Deliverables'''
:3 clear quantitatively measurable goals to determine project success/failure status which will help in evaluation
:* Month 01: Compete high-quality end-to-end migration of 100 pages
:* Month 02: Compete high-quality end-to-end migration of 300 pages
:* Month 03: Compete high-quality end-to-end migration of 345 pages
:'''Project Timeline:'''
::{| class="wikitable"
|Week
|Date(2018)
|Period
|Task
|-
|
|Today - April 22
|
|
* Research about the variety of content in different wiki-pages to be converted
* Discuss with the community about anything important which comes up
* Learn more about syntax of wikitext, different functionalities of MediaWiki API
|-
|
|April 23 - May 13
|Community Bonding
|
* Set up Development environment(Install necessary software, packages, libraries)
* Set up a dedicated blog for GSoC 2018
* Blog post about my plans for Coding Month 01
|-
|
|
|
|
|-
|
|May 14 - June 10
|Coding Month 01
|
|-
|01
|May 14 - May 20
|
|
* Write Script
* Test Script extensively
|-
|02
|May 21 - May 27
|
|
* Complete end-to-end migration of 30 Pages
|-
|03
|May 28 - June 03
|
|
* Complete end-to-end migration of 65 Pages
|-
|04
|June 04 - June 10
|
|
* Complete end-to-end migration of 100 Pages
* Blog post about my plans for Coding Month 02
|-
|
|
|
|
|-
|
|June 11 - July 08
|Coding Month 02
|
|-
|05
|June 11 - June 17
|First Midterm Evaluations
|
* Quality Check of all pages migrated during Coding Month 01
* Submit Evaluations
* Complete end-to-end migration of 150 Pages
|-
|06
|June 18 - June 24
|
|
* Complete end-to-end migration of 200 Pages
|-
|07
|June 25 - July 01
|
|
* Complete end-to-end migration of 250 Pages
|-
|08
|July 02 - July 08
|
|
* Complete end-to-end migration of 300 Pages
* Blog post about my plans for Coding Month 03
|-
|
|
|
|
|-
|
|July 09 - August 05
|Coding Month 03
|
|-
|09
|July 09 - July 15
|Second Midterm Evaluations
|
* Quality Check of all pages migrated during Coding Month 02
* Submit Evaluations
* Complete end-to-end migration of 345 Pages
|-
|10
|July 16 - July 22
|
|
* Final Quality Check of all migrated pages
* Detailed documentation about everything related to this project
|-
|11
|July 23 - July 29
|
|
* Clean up Development environment
* Buffer time to accommodate any due/extra/unknown work
|-
|12
|July 30 - August 05
|
|
* Buffer time to accommodate any due/extra/unknown work
|-
|
|
|
|
|-
|
|August 06 - August 14
|Final Evaluations
|
* Submit Evaluations
* Be Humble, and thank everyone for the opportunity :)
|}
:'''Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant'''
:{{highlight | what better way to prove that I can do the work, than doing some 'real' work?}}
: Find the beta version of proposed script [https://github.com/rdrsadhu/beta-migration-script/blob/master/migrate.ipynb here]
:* I implemented some basic features of the script, which
:** given any Sugar Activity pagename and forked_repo_url, migrates the page(without any manual supervision) and commits all generated files into the local copy of forked-repository
:** The script is commented to explain what each part is doing
:** The script follows, roughly the same workflow stated in ''Detailed Technical description of Migration Process'' above
:I tried the script on 3 different pages of Activities.
:Here are the results:
:* [[Activities/AEIOU]] -> [https://github.com/rdrsadhu/AEIOU https://github.com/rdrsadhu/AEIOU]
:* [[Activities/Portfolio]] -> [https://github.com/rdrsadhu/portfolio-activity https://github.com/rdrsadhu/portfolio-activity]
:* [[Activities/Cookie_Search]] -> [https://github.com/rdrsadhu/cookie-search-activity https://github.com/rdrsadhu/cookie-search-activity]
---------------------------------------
:'' Note: I'm aware of the sub-optimal output from pandoc. and that is what I plan to refine during the summer. It will require a lot of careful observations(and maybe some manual cleanup as well according to diverse page content) and thus was not possible to implement in this limited timeframe.''
----------------------------------------
:I do not have any other commitments during the summer, and will be able to devote complete time & energy to implement this project at the best of its quality.
:Moreover, I'm excited to learn and willing to push myself.
=== Project and the Community ===
'''If the project is successfully completed, what will be its impact on the Sugar Labs community?'''
::''Answer 1: Rudra Sadhu:''
::* All information about 1 particular Sugar Activity, will live inside its GitHub Repository, which will help
::** Activity Maintainers
::** New members of the community
::** Users
::** and ultimately everyone '':)''
::* GitHub is the world's leading software development platform, ([https://insights.stackoverflow.com/survey/2018/#work-version-control check] Stack Overflow 2018 developer survey)
::** thus hosting a complete repository with all the documentation, will provide greater exposure and surely help to attract more developers and traffic to the community
::''Answer 2: SL Community Member-1:''
::* Please share your views
::''Answer 3: SL Community Member-2:''
::* Please share your views
'''What will I do if I get stuck on the project and my mentor isn't around?'''
* I know where to get information, or ask for help (''google, stackoverflow.com, etc'')
* Read documentation of related tools
* Ask other Sugar Labs members via IRC, developer mailing lists
* Ask help from Sugar Labs GSoC coordinator
'''How do I propose to keep the community informed of my progress and any problems or questions I might have over the course of the project?'''
* daily updates on IRC
* weekly blog post
** about what I did the previous week
** what I plan to do the next week
* communication via mailing-lists (as and when needed)
* all the code I write and every Pull-Requests/Issues I open
** will be thoroughly commented in an easy to understand format
* Live Record of Activity migration status for all the 345 pages.
** I intend to create a wiki-page/git-repo which at any time will reflect the current migration status of all the 345 pages. Something like [https://github.com/rdrsadhu/beta-migration-script this]
=== Miscellaneous ===
'''Is it mandatory to set up Sugar development environment and attach a screenshot ?'''
: because this project; does neither directly requires, nor depends on the Sugar development environment
'''Describe a great learning experience you had as a child'''
: Coming Soon
'''Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?'''
: Coming Soon
Drafted with ❤ by another Open Source enthusiast, just like you :)
[[Category:2018 GSoC applications]]
''Note: This is a work in progress. The proposal will be further modified and improved, upon discussions and feedback from the Sugar Labs community''
== Project Name: Attentive Migration of wiki activity pages to git ==
== Author : Rudra Sadhu ==
=== About Me ===
:'''Name:''' Rudra Sadhu
:'''Email:''' [mailto:rdrsadhu@gmail.com rdrsadhu@gmail.com]
:'''Sugar Labs wiki username:''' rdrsadhu (user-page at [[User: rdrsadhu]])
:'''IRC nickname on irc.freenode.net:''' rdrsadhu
:'''Languages:''' English, Hindi, Bengali
:'''Where am I located? and what hours(UTC) do I tend to work?'''
:* I'm located at Kolkata, India (UTC +05:30)
:* Working Hours: Flexible (Whatever works for both me and my mentor)
:'''Past experiences with Open-Source projects:'''
:* actively contributing to Open-Source since August, 2017
:* organisation: [https://github.com/oppia Oppia]
::* firstly, Why Oppia(and now Sugar Labs)?
:::: I've always believed, '' 'there is no process as powerful as education to change the world' ''
:::: Mission of Oppia Foundation and Sugar Labs are similar(if not exactly same). Read [http://oppiafoundation.org/mission/ here]
::* My first pull request : [https://github.com/oppia/oppia/pull/3743 Fix #3258: Add share-to-classroom Button] ''~Happiness is when pull-requests gets merged :)''
::* What else did I chip in?
:::* while playing around, Found an issue in the application,
:::: Recorded it : [https://github.com/oppia/oppia/issues/3750 https://github.com/oppia/oppia/issues/3750]
:::: Submitted fix: [https://github.com/oppia/oppia/pull/3754 https://github.com/oppia/oppia/pull/3754] ''~Felt Awesome!''
:::* Created outline for Mathematics Lessons(Geometry)
:::* 6 other Merged pull-requests. Complete list [https://github.com/oppia/oppia/pulls?q=is%3Apr+author%3ARdrsadhu+is%3Amerged+sort%3Acreated-asc here]
::::: these are either [https://en.wikipedia.org/wiki/Code_refactoring Code Refactoring] (which proves my skill to understand complex codebases, and knowledge of intermediate git workflow- dealing with branches, merge-conflicts etc)
::::: or Trivial Documentation fixes (which confirms my attention to detail)
:* '''What did I gain out of contributing to Open Source projects and why I'm again up for it?'''
::* I learned a lot! and more importantly, had fun learning.
::* A sense of pride and satisfaction, to be able to contribute for a good cause, which impacts people around the globe.
::* Mentions on the [https://www.oppia.org/about#credits Credits Page]. Even if I die tomorrow, this will stay on.
::* I've got nothing to lose :D
:* I've tasted failures as well, and I'm not uncomfortable to talk about them. Well, because they often teach us a lot more than successes.
:: [https://github.com/oppia/oppia/pull/3924 this] pull-request of mine did not get merged.
=== About Project ===
:'''Project Name:''' <u>Attentive</u> Migration of wiki activity pages to git
:'''Description:'''
::* At present, the [[Activities#Sugar_Activities]] section in Sugar Labs wiki lists 345 pages.
::* These pages individually serves as homepages(containing all relevant information), for different Sugar Activities.
::: example: [[Activities/MakeyMakey]] is the homepage for [http://activities.sugarlabs.org/en-US/sugar/addon/4729 MakeyMakey] activity. Whereas, its source-code is hosted at [https://github.com/sugarlabs/makeymakey https://github.com/sugarlabs/makeymakey]
::* With every new activity, the volume of wiki.sugarlabs.org is expanding, and thus it is getting harder to maintain all of the stuff at a single place.
::* Also, as Sugar Labs is moving towards GitHub style of development (see [http://lists.sugarlabs.org/archive/sugar-devel/2018-January/055005.html discussion])
::: it would be beneficial(and more maintainable) in the long run if these 345 wiki pages were embedded in their corresponding git repositories.
:'''Objective:'''
::Write a program(or script) to migrate all of the above-mentioned wiki-content to their corresponding git repositories in markdown format, with great attention to quality.
:'''Promised Outcome:'''
::100% of mentioned wiki-pages(from wikitext markup) moved to their git repositories(in markdown format).
::*Something like [https://github.com/rdrsadhu/portfolio-activity https://github.com/rdrsadhu/portfolio-activity], from [[Activities/Portfolio]]
::**'' this is a fork of the original repository [https://github.com/sugarlabs/portfolio-activity https://github.com/sugarlabs/portfolio-activity]
::**'' I'm aware that the README.md file is not optimal.
::***'' I intend to discuss a few things with the community, before starting to optimize the conversion process, which will be the most important part of this project.''
::Also, all the current wiki-pages will be deprecated(deleted/moved? to be discussed with the community)
:'''Technologies used:'''
::* Programming Languages: Python 3.6
::* Tools: [https://git-scm.com/ git], [https://pandoc.org/ pandoc]
::* APIs: [https://www.mediawiki.org/wiki/API:Main_page MediaWiki API]
:'''High-Level overview of the Migration Process:'''
::For each page to migrate
::* Step 0: Determine to which GitHub repository, it'll be added
::* Step 1: from wiki.sugarlabs.org/activities/activity_page, Get source file(wikitext) which is to be converted(to markdown)
::* Step 2: Get associated extra files(images etc) used in the wiki-page
::* Step 3: Convert wikitext content to Markdown
::* Step 4: Add Converted Markdown files to GitHub repository mentioned in Step 0
::* Step 5: Delete/Archive wiki-page and associated extra files from wiki.sugarlabs.org
:'''Detailed Technical description of Migration Process'''
:* Step 1: using MediaWiki API, query wiki.sugarlabs.org to get list of all pages to convert
:* Step 2: For each page, research and find out(or discuss with mentor/community) where to place them in GitHub
:**''there isn't a one:one correspondence for all the pages and the git repositories''
:**''for example:''
:***''in the section [[Activities#Sugar_Activities]], there are at least 20 pages as Activities/Turtle Art/Tutorials/wiki-page-name , which I believe should be in the same git repository
:***''Some git repositories already has a README.md file, which contains information not available in the corresponding wiki-page (See [https://github.com/sugarlabs/Measure activity-git-repo] : [https://wiki.sugarlabs.org/go/Activities/Measure activity-wiki-page])
:***''The variety is a lot more, which I plan to extensively discuss, before the coding-period starts.
:* Step 3: For each GitHub repository to push converted markdown files:
:** 3.1: Fork the repository (create a copy of the original repository into my-GitHub-account)
:** 3.2: Pull the forked repository (get a local copy of it, in my development machine)
:** 3.3: For each file to be pushed into the repository:
:*** Using MediaWiki API, query a specific wiki-page, to get its raw source(in wikitext format), and all associated files(images etc)
:*** create a safe backup of the original raw wikitext
:*** generate one temporary duplicate file(containing raw wikitext), to convert into markdown format
:*** using pandoc, convert
:*** while the conversion is not perfect (it is difficult or sometimes not-possible, to generate the exact functionalities of a wiki-page into a markdown file. For example, image-galleries)
:**** modify the temporary wikitext file, with attention to every small detail
:**** and convert again
:** 3.3: Commit all newly generated files (also the safe wikitext backup; in-case the community decides to keep it for future reference)
:** 3.4: git push to Forked Repository
:** 3.5: Send a Pull Request to original Repository
:** 3.6: After Pull Request gets merged;
:*** redirect the wiki-page to its git repository
:*** using MediaWiki API, delete/move contents of original wiki-page
:'''Project Deliverables'''
:3 clear quantitatively measurable goals to determine project success/failure status which will help in evaluation
:* Month 01: Compete high-quality end-to-end migration of 100 pages
:* Month 02: Compete high-quality end-to-end migration of 300 pages
:* Month 03: Compete high-quality end-to-end migration of 345 pages
:'''Project Timeline:'''
::{| class="wikitable"
|Week
|Date(2018)
|Period
|Task
|-
|
|Today - April 22
|
|
* Research about the variety of content in different wiki-pages to be converted
* Discuss with the community about anything important which comes up
* Learn more about syntax of wikitext, different functionalities of MediaWiki API
|-
|
|April 23 - May 13
|Community Bonding
|
* Set up Development environment(Install necessary software, packages, libraries)
* Set up a dedicated blog for GSoC 2018
* Blog post about my plans for Coding Month 01
|-
|
|
|
|
|-
|
|May 14 - June 10
|Coding Month 01
|
|-
|01
|May 14 - May 20
|
|
* Write Script
* Test Script extensively
|-
|02
|May 21 - May 27
|
|
* Complete end-to-end migration of 30 Pages
|-
|03
|May 28 - June 03
|
|
* Complete end-to-end migration of 65 Pages
|-
|04
|June 04 - June 10
|
|
* Complete end-to-end migration of 100 Pages
* Blog post about my plans for Coding Month 02
|-
|
|
|
|
|-
|
|June 11 - July 08
|Coding Month 02
|
|-
|05
|June 11 - June 17
|First Midterm Evaluations
|
* Quality Check of all pages migrated during Coding Month 01
* Submit Evaluations
* Complete end-to-end migration of 150 Pages
|-
|06
|June 18 - June 24
|
|
* Complete end-to-end migration of 200 Pages
|-
|07
|June 25 - July 01
|
|
* Complete end-to-end migration of 250 Pages
|-
|08
|July 02 - July 08
|
|
* Complete end-to-end migration of 300 Pages
* Blog post about my plans for Coding Month 03
|-
|
|
|
|
|-
|
|July 09 - August 05
|Coding Month 03
|
|-
|09
|July 09 - July 15
|Second Midterm Evaluations
|
* Quality Check of all pages migrated during Coding Month 02
* Submit Evaluations
* Complete end-to-end migration of 345 Pages
|-
|10
|July 16 - July 22
|
|
* Final Quality Check of all migrated pages
* Detailed documentation about everything related to this project
|-
|11
|July 23 - July 29
|
|
* Clean up Development environment
* Buffer time to accommodate any due/extra/unknown work
|-
|12
|July 30 - August 05
|
|
* Buffer time to accommodate any due/extra/unknown work
|-
|
|
|
|
|-
|
|August 06 - August 14
|Final Evaluations
|
* Submit Evaluations
* Be Humble, and thank everyone for the opportunity :)
|}
:'''Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant'''
:{{highlight | what better way to prove that I can do the work, than doing some 'real' work?}}
: Find the beta version of proposed script [https://github.com/rdrsadhu/beta-migration-script/blob/master/migrate.ipynb here]
:* I implemented some basic features of the script, which
:** given any Sugar Activity pagename and forked_repo_url, migrates the page(without any manual supervision) and commits all generated files into the local copy of forked-repository
:** The script is commented to explain what each part is doing
:** The script follows, roughly the same workflow stated in ''Detailed Technical description of Migration Process'' above
:I tried the script on 3 different pages of Activities.
:Here are the results:
:* [[Activities/AEIOU]] -> [https://github.com/rdrsadhu/AEIOU https://github.com/rdrsadhu/AEIOU]
:* [[Activities/Portfolio]] -> [https://github.com/rdrsadhu/portfolio-activity https://github.com/rdrsadhu/portfolio-activity]
:* [[Activities/Cookie_Search]] -> [https://github.com/rdrsadhu/cookie-search-activity https://github.com/rdrsadhu/cookie-search-activity]
---------------------------------------
:'' Note: I'm aware of the sub-optimal output from pandoc. and that is what I plan to refine during the summer. It will require a lot of careful observations(and maybe some manual cleanup as well according to diverse page content) and thus was not possible to implement in this limited timeframe.''
----------------------------------------
:I do not have any other commitments during the summer, and will be able to devote complete time & energy to implement this project at the best of its quality.
:Moreover, I'm excited to learn and willing to push myself.
=== Project and the Community ===
'''If the project is successfully completed, what will be its impact on the Sugar Labs community?'''
::''Answer 1: Rudra Sadhu:''
::* All information about 1 particular Sugar Activity, will live inside its GitHub Repository, which will help
::** Activity Maintainers
::** New members of the community
::** Users
::** and ultimately everyone '':)''
::* GitHub is the world's leading software development platform, ([https://insights.stackoverflow.com/survey/2018/#work-version-control check] Stack Overflow 2018 developer survey)
::** thus hosting a complete repository with all the documentation, will provide greater exposure and surely help to attract more developers and traffic to the community
::''Answer 2: SL Community Member-1:''
::* Please share your views
::''Answer 3: SL Community Member-2:''
::* Please share your views
'''What will I do if I get stuck on the project and my mentor isn't around?'''
* I know where to get information, or ask for help (''google, stackoverflow.com, etc'')
* Read documentation of related tools
* Ask other Sugar Labs members via IRC, developer mailing lists
* Ask help from Sugar Labs GSoC coordinator
'''How do I propose to keep the community informed of my progress and any problems or questions I might have over the course of the project?'''
* daily updates on IRC
* weekly blog post
** about what I did the previous week
** what I plan to do the next week
* communication via mailing-lists (as and when needed)
* all the code I write and every Pull-Requests/Issues I open
** will be thoroughly commented in an easy to understand format
* Live Record of Activity migration status for all the 345 pages.
** I intend to create a wiki-page/git-repo which at any time will reflect the current migration status of all the 345 pages. Something like [https://github.com/rdrsadhu/beta-migration-script this]
=== Miscellaneous ===
'''Is it mandatory to set up Sugar development environment and attach a screenshot ?'''
: because this project; does neither directly requires, nor depends on the Sugar development environment
'''Describe a great learning experience you had as a child'''
: Coming Soon
'''Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?'''
: Coming Soon
Drafted with ❤ by another Open Source enthusiast, just like you :)
[[Category:2018 GSoC applications]]