Line 6: |
Line 6: |
| | | |
| | | |
| + | '''Update: One-time task completed and contributed to major issues.''' |
| == About You == | | == About You == |
| '''Name''' - Vipul Gupta<br /> | | '''Name''' - Vipul Gupta<br /> |
Line 60: |
Line 61: |
| '''Technologies and Skills Used''' <br /> | | '''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, 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 - PyGitHub |
| * '''Others''' - Yaml (If Ansible is used) | | * '''Others''' - Yaml (If Ansible is used) |
| | | |
Line 72: |
Line 73: |
| '''Detailed Description of the steps mentioned ''' | | '''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''' - Used GitHub API and PyGithub to find all repository links that don't have a README.md and are a activity under SugarLabs organisation. [https://github.com/sugarlabs/sugar-docs/issues/102 Completed] and [https://gist.github.com/vipulgupta2048/6eef7de43ac628e8e7ed11217fbb1803 Scripts availabe here] |
| | | |
| *'''Step 0''' - Extracting content; from these methods that offers the least redundancies. My research yielded these results. | | *'''Step 0''' - Extracting content; from these methods that offers the least redundancies. My research yielded these results. |
Line 224: |
Line 225: |
| * 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. | | * 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, |
| - 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 /> | + | - Since Python is used widely, my previous projects justify my skill and flexibility 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. (Refer Miscellaneous section) <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) |
| + | - Completed the '''one time task''' in my '''migration process''' beforehand and also solving a [https://github.com/sugarlabs/sugar-docs/issues/102 pending issue] related to it. Used '''GitHub API''' and '''PyGithub''' which seems much more effective then Scraping (using Scrapy) as mentioned before. Scripts are availabe [https://gist.github.com/vipulgupta2048/6eef7de43ac628e8e7ed11217fbb1803 here].<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?'''<br /> | + | '''If your project is successfully completed, what will its impact be on the Sugar Labs community?''' |
| *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. | | *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. |
Line 258: |
Line 260: |
| '''Answer 4:''' Tony Anderson - quozl@laptop.org <br /> | | '''Answer 4:''' Tony Anderson - quozl@laptop.org <br /> |
| (His comments clarifying the need of WikiPort and the problems it solves) | | (His comments clarifying the need of WikiPort and the problems it solves) |
− | As always, the question is the impact on our users. The traditional source of information for users is [1] and [2] and, especially the wiki pages. So far the effect of gitHub has been to reduce the value of these two sources. In many cases the activities on ASLO have been superseded by ones on gitHub or other git repository but are not available to our users. The documentation of activities on ASLO has never been adequate but now no effort will be made to improve it. This continues the trend toward Sugar being a playground for the technical elite. Complete conversation available here. | + | As always, the question is the impact on our users. The traditional source of information for users is [1] and [2] and, especially the wiki pages. So far the effect of gitHub has been to reduce the value of these two sources. In many cases the activities on ASLO have been superseded by ones on Github other git repository but are not available to our users. The documentation of activities on ASLO has never been adequate but now no effort will be made to improve it. This continues the trend toward Sugar being a playground for the technical elite. Complete conversation available here. |
| [1] http://www.sugarlabs.org [2] http://www.laptop.org | | [1] http://www.sugarlabs.org [2] http://www.laptop.org |
| | | |