Changes

Jump to navigation Jump to search
110 bytes removed ,  14:17, 21 April 2018
m
no edit summary
Line 49: Line 49:  
   
 
   
 
'''My understanding of the problem and why it needs to be solved?'''<br />
 
'''My understanding of the problem and why it needs to be solved?'''<br />
Documentation, as mentioned before, is important to all open-source projects. Sugar Labs has all documentation for its learner applications called “Activities” at one place in the Activities#Sugar_Activities. Some problem (#risks) that I found with this sort of implementation is as follows:- <br />
+
Documentation, as mentioned before, is important to all open-source projects. Sugar Labs has all documentation for its learner applications called “Activities” at one place in the Activities#Sugar_Activities. Some problem (#risks) that I found with this sort of implementation is as follows:-  
    
# '''Difficult to add, edit and manage'''  - In reference to the conversation [archive/sugar-devel] As a user, I need to create an account for editing privileges. Which is very tiresome to be very honest, hence discouraging contributions.  
 
# '''Difficult to add, edit and manage'''  - In reference to the conversation [archive/sugar-devel] As a user, I need to create an account for editing privileges. Which is very tiresome to be very honest, hence discouraging contributions.  
# '''Size issues''' - Wiki is being hosted on the a server. With the growing number of activities, the size occupied by them will increase leading to rise in maintenance cost. Not to mention buying more space.  
+
# '''Size issues''' - Wiki is being hosted on a a server. With the growing number of activities, the size occupiewould l increasl leading atsurge i in maintenance cost. Not to mention buying more space.  
 
# '''No clear format/classification''' - Some links are for one activity only while other activities have multiple links for them (example Turtle Art) Results in time being wasted of the user even if they are justified.  
 
# '''No clear format/classification''' - Some links are for one activity only while other activities have multiple links for them (example Turtle Art) Results in time being wasted of the user even if they are justified.  
- Found 2 wiki pages of the same activity. (this page and this too)
+
I did extensive research on the same and found many such problems with the wiki. According to my experience in open-source, users just need information fast, easily accessible and neatly organized. A new method to make that information organized should be brought in place for the betterment of the whole community. GitHub could be the solution to all our problems () WikiPort is a tool that helps in migration process of wiki’s to Github hosted README.md.  
I did extensive research on the same and found many such problems with the wiki. According to my experience in open-source, users just need information fast, easily accessible and neatly organized. <br />
  −
A new method to make that information organized should be brought in place for the betterment of the whole community. GitHub could be the solution to all our problems (Check here for reference) WikiPort is a tool that helps in migration process of wiki’s to Github hosted README.md.  
   
   
 
   
 
== Objective == <br />
 
== Objective == <br />
Line 63: 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, Beautifulsoup etc. Python will be used widely in this project.  
+
* '''Programming Language''': Python 3.6 using libraries such as requests, LXML, Beautifulsoup etc. Python3 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.)

Navigation menu