Line 1: |
Line 1: |
− | = Google Summer of Code 2018 Project Proposal= | + | = Google Summer of Code 2018 Project= |
| + | Migration Status of all pages [https://github.com/rdrsadhu/beta-migration-script/blob/master/README.md here] |
| | | |
− | ''Note: This is a work in progress. As I continue to work and learn more about the task, this page will be further modified and improved.
| + | ------- |
| + | Project Name: [https://summerofcode.withgoogle.com/projects/#5549173819047936 Migration of activity wiki-pages to GitHub (and simultaneously help-activity)] |
| | | |
− | '' Feel free to share your opinions and discuss anything related to this topic.
| + | Author : Rudra Sadhu |
| | | |
− | == Project Name: Attentive Migration of wiki activity pages to git ==
| + | Status: '''<span style="color:#00ff00"> ACCEPTED </span>''' |
− | == Author : Rudra Sadhu ==
| |
| | | |
− | Migration Status of all 345 pages [https://github.com/rdrsadhu/beta-migration-script/blob/master/README.md here]
| |
| | | |
− | == Contributions after submitting the final proposal via GSoC dashboard ==
| |
− | 1. https://github.com/godiard/help-activity/pull/41
| |
| | | |
− | 2. https://github.com/sugarlabs/JClic/pull/4
| + | == Research == |
| + | Results of careful observations about the diverse content of different pages, diving deep into the codebase, and discussions with the community |
| | | |
− | == Research about the Activities wiki-pages ==
| + | 1. Some wiki-pages have already been moved to GitHub and thus repeating the work would result in duplication. |
− | 1.
| + | * [[Activities/Turtle_Art]] |
| | | |
− | 2. | + | 2. Some wiki-pages are not in English. An English translation should be added for these pages(?) |
| + | * [[Activities/JClic]] |
| + | * [[Activities/Conozco_America]] |
| + | * [[Activities/Conozco-Nicaragua]] |
| | | |
| + | 3. A few of the activities do not start, so perhaps its documentation would be misleading if included in Help Activity. |
| | | |
| + | Instead, the documentation could be moved to the source repository(temporarily) |
| + | * [[Activities/Bulletin_Board]] (Refer https://github.com/godiard/help-activity/pull/47) |
| + | * [[Activities/Ruler]] (Refer https://github.com/godiard/help-activity/pull/43) |
| + | |
| + | 4. Quite a few pages are redirects to other pages. |
| + | * [https://wiki.sugarlabs.org/index.php?title=Activities/TurtleArt/Logo&redirect=no Activities/TurtleArt/Logo] |
| + | * [https://wiki.sugarlabs.org/index.php?title=Activities/TurtleArt/Help&redirect=no Activities/TurtleArt/Help] |
| + | |
| + | |
| + | == Proposal == |
| + | ''The .pdf version as submitted via the GSoC dashboard is available [https://drive.google.com/file/d/18jMfTuw2jetWpHeh_4g4FTM2AdCFG8Zf/view?usp=sharing here]. (Last Updated March 27, 2018) |
| === About Me === | | === About Me === |
| | | |
Line 106: |
Line 120: |
| :* Step 1: Query wiki.sugarlabs.org to get list of all pages to convert | | :* Step 1: Query wiki.sugarlabs.org to get list of all pages to convert |
| :* Step 2: For each page, research and find out(or discuss as needed with mentor/community) where to place them in GitHub | | :* Step 2: For each page, research and find out(or discuss as needed with mentor/community) where to place them in GitHub |
− | ::{{highlight | Add stuff here}} | + | ::<code> |
| + | :: We have three audiences for documentation, |
| + | :: a) users; such as children who are learners, and their teachers |
| + | :: b) integrators; who join many activities into a system, |
| + | :: c) developers; who develops Sugar and maintains its activities. |
| + | |
| + | ::Activity pages does not only conatins user documentation, but also developer documentation. Some activity pages have both, some have only one or the other. |
| + | ::example: |
| + | ::1. [[Activities/TamTam]] is developer documentation, and should be moved to [https://github.com/sugarlabs/tamtam tamtam] |
| + | ::2. [[Activities/Story]] is user documentation, and should be moved to [https://github.com/godiard/help-activity help-activty] |
| + | ::3. [[Activities/Physics]] is both, Some decision will be needed on a case to case basis to deal with these pages. |
| + | </code> |
| :* Step 3: For each GitHub repository to push converted files: | | :* Step 3: For each GitHub repository to push converted files: |
| :** 3.1: Fork the repository | | :** 3.1: Fork the repository |
Line 116: |
Line 141: |
| :*** generate one temporary duplicate file(containing raw wikitext), for conversion | | :*** generate one temporary duplicate file(containing raw wikitext), for conversion |
| :*** using pandoc, convert | | :*** using pandoc, convert |
− | :**** {{highlight | Add stuff here}} | + | :**** <code> to Markdown or reStructuredText? </code> |
| + | :***** <code>for content that is to be in the corresponding source repository in GitHub, use .md</code> |
| + | :***** <code>for user documentation content that is to be in the Help Activity in Sugar, use .rst</code> |
| :*** 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) | | :*** 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 | | :**** modify the temporary wikitext file, with attention to every small detail |
Line 257: |
Line 284: |
| | | |
| Drafted with ❤ by another Open Source enthusiast, just like you :) | | Drafted with ❤ by another Open Source enthusiast, just like you :) |
− |
| |
− | ''The pdf(Last Updated March 27, 2018) submitted via the GSoC dashboard is available [https://drive.google.com/file/d/18jMfTuw2jetWpHeh_4g4FTM2AdCFG8Zf/view?usp=sharing here].
| |
| | | |
| [[Category:2018 GSoC applications]] | | [[Category:2018 GSoC applications]] |