Line 14: |
Line 14: |
| * The idea came from one of the suggested proposals for the GSoF for Sugar Labs, but I want to expand it a bit further. While now a days we are working hard to create curriculum for the young for them to learn how to code at a young age, and while we are quickly integrating programming as an essential part of the education system we are not teaching them how to document and share their code properly. So while we are making huge strides to ensure the future generations know how to code we are neglecting the equally important task pf teaching them how to properly share that code with the world and to do in a way that i well documented. The idea is to create a kid friendly verioning repo mainly for the sugar labs platform, but the end goal would be to make this a global entry to the world of git, and other repo's. So the goal is to make a user friendly introduction to version for kids to version their code while also making a documentation system to go along with it. So that kids can start from a young age to document and version their code and programming projects, essentially creating a layer between the user and git that would simplify the way they can version and document the code. This would be done using the git python API to create the UI, and the back end will be in c so that it can run nice and fast. | | * The idea came from one of the suggested proposals for the GSoF for Sugar Labs, but I want to expand it a bit further. While now a days we are working hard to create curriculum for the young for them to learn how to code at a young age, and while we are quickly integrating programming as an essential part of the education system we are not teaching them how to document and share their code properly. So while we are making huge strides to ensure the future generations know how to code we are neglecting the equally important task pf teaching them how to properly share that code with the world and to do in a way that i well documented. The idea is to create a kid friendly verioning repo mainly for the sugar labs platform, but the end goal would be to make this a global entry to the world of git, and other repo's. So the goal is to make a user friendly introduction to version for kids to version their code while also making a documentation system to go along with it. So that kids can start from a young age to document and version their code and programming projects, essentially creating a layer between the user and git that would simplify the way they can version and document the code. This would be done using the git python API to create the UI, and the back end will be in c so that it can run nice and fast. |
| * Timeline: | | * Timeline: |
| + | ** 0th Week Now: Prototype |
| + | *** Starting now the idea is to prototype some ideas on what the documentation system can be made to simulate the real world yet still be simple to use. The idea is to have some idea of what the project will look by the start of the project. |
| ** Start of Project May 19: Initial analysis of the way journal works right now. | | ** Start of Project May 19: Initial analysis of the way journal works right now. |
| ** 1st Week May 17 - May 23: Decide what can stay and be reused and what needs to be rewritten. | | ** 1st Week May 17 - May 23: Decide what can stay and be reused and what needs to be rewritten. |
Line 30: |
Line 32: |
| *** Now that the local side of the project is up and running we can start working on connecting it to an online repo. This will entail creating a simple solution to exporting it to existing sites such as gitHub or to create a more "kid" friendly alternative where kids can store their code and work on it from home or another computer. | | *** Now that the local side of the project is up and running we can start working on connecting it to an online repo. This will entail creating a simple solution to exporting it to existing sites such as gitHub or to create a more "kid" friendly alternative where kids can store their code and work on it from home or another computer. |
| ** 8th Week July 5 - July 11: Finishing online | | ** 8th Week July 5 - July 11: Finishing online |
− | *** By the end of this week the goal ois to have a working and functional mechanism to connect our newilt created repo to an online one be it to a new "SugarLabsHub" or to an existing repo website. | + | *** By the end of this week the goal is to have a working and functional mechanism to connect our newly created repo to an online one be it to a new "SugarLabsHub" or to an existing repo website. |
| + | ** 9th Week July 12 - July 18: Integration |
| + | *** This weeks focus is to integrate and make sure it all works together. |
| + | **10th - 12th Week July 19 - August 8: Testing |
| + | *** Beta testing and bug reporting, hopefully i can get some of the community to participate in the testing and bug reporting. |
| + | **13th Week August 9 - August 15: Regroup and Debug |
| + | *** Fix final bugs, make changes and implementations that the community might request, ensure that we have robust code that is well documented and ready for release. |
| + | ** Final Week: Putting the cherry on top of the cake |
| + | *** This week is the final week, so everything should be tested, documented, and working to perfection and should be ready to expand if need be to anything that this project needs to become. The idea of this week is to have working code that is also modular enough to grow in the future. |
| * 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. | | * 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. |
| | | |