Line 74: |
Line 74: |
| '''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 ''' -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. |
| : 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 -''' 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 | + | * '''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 - Python script to find all image links and then fetches media (images) associated with the activity from web-page; renames them in correct format; adds them to repository folder cloned under “ images” Fix image links and testing. |
− | Step 3 | + | * '''Step 4 -''' Ensuring content is not duplicated by being already present either in the README.md file or the user documentation in the help-activity. Make the necessary changes, fix broken links. Testing; Commit and push to fork. |
− | Python script to find all image links and then fetches media (images) associated with activity from web-page; renames them in correct format; adds them to repository folder cloned under “ images” Fix image links and testing. | + | * '''Step 5 -''' Pull request submitted with the detailed description of the changes in activity documentation in clear format containing all details. When PR merged, move to step 6. |
− | Step 4 | + | * '''Step 6 -''' Use Pywikibot (Check delete.py) to delete pages/media associated with wiki page using admin privileges and link back to their repositories. This can also be achieved using the mediawiki API which saves edit history as I mentioned before. (Read more here) (End-to-end Migration of wiki page complete) |
− | Ensuring content is not duplicated by being already present either in the README.md file or the user documentation in the help-activity. Make the necessary changes, fix broken links. Testing; Commit and push to fork.. | + | * '''Step 7''' - Repeat Step 1 for next activity. |
− | Step 5 | |
− | Pull request submitted with detailed description of the changes in activity documentation in clear format containing all details. When PR merged, move to step 6. | |
− | Step 6 | |
− | Use Pywikibot (Check delete.py) to delete pages/media associated with wiki page using admin privileges and link back to their repositories. This can also be achieved using the mediawiki API which saves edit history as I mentioned before. (Read more here) (End-to-end Migration of wiki page complete) | |
− | Step 7 | |
− | Repeat Step 1 for next activity. | |
− | | |
| | | |
| == Project Deliverables == | | == Project Deliverables == |
Line 101: |
Line 94: |
| # 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. | | # 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 determine project status which will help in evaluation i.e'''<br /> | + | '''Thus, by the deliverables mentioned above, 3 well-defined goals that determine project status which will help in evaluation i.e'''<br />1. Evaluation 1: Migration of 100 wiki-pages complete; <br />2. Evaluation 2: Migration of 300 wiki-pages complete;<br />3. Final: Migration of 345 wiki-pages;<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) == |
Line 129: |
Line 119: |
| ! Week Number [#] !! Tasks | | ! Week Number [#] !! Tasks |
| |- | | |- |
− | | [#1] April 23 - April 30 || Week 1 [#1] | + | | [#1] April 23 - April 30 || Community Bonding Period |
− | Community Bonding Period | + | Community Bonding, if possible keen on having a meeting with the Activity and wiki team. Discussion of ideas that I have. Research Part 1 |
− | Community Bonding, if possible keen on having a meeting with the Activity and wiki team. Discussion of ideas that I have. | + | MediaWiki [Syntax, documentation, API, functionalities]; GitHub API; Wikitext; Exploring the problem case defined earlier. |
− | Research Part 1 | |
− | MediaWiki [Syntax, documentation, API, functionalities] | |
− | Wikitext | |
− | Exploring the problem case defined earlier. | |
| |- | | |- |
| | [#2] April 1 - May 7 | | | [#2] April 1 - May 7 |
− | || Start documentation and blog post, about Sugar Labs on my blog. | + | || Start documentation and blog post, about Sugar Labs on my blog.Setup: development environment. |
− | Setup: development environment. | + | Continue with Research |
− | Continue with Research Part 2 | + | |
− | Finding, testing, implementing solutions available for Migration Process step 0 through 6. | + | Part 2 - Finding, testing, implementing solutions available for Migration Process step 0 through 6. Discuss results with the 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 |
| |- | | |- |