Changes

Jump to navigation Jump to search
no edit summary
Line 62: Line 62:  
I will be integrating the Discourse open-source discussion platform into sugar. This will be done in such a way that the users can launch themselves into discussion on any topic regarding sugar right from the sugar shell. This will be much like sugar help where users can click on the help icon to access context based help.
 
I will be integrating the Discourse open-source discussion platform into sugar. This will be done in such a way that the users can launch themselves into discussion on any topic regarding sugar right from the sugar shell. This will be much like sugar help where users can click on the help icon to access context based help.
   −
This project is aimed at all sugar users. The ability to start a discussion on any help-related topic with a single mouse click will be, I believe, extremely helpful for the users. That's why this project needs to be undertaken.
+
This project is aimed at all sugar users. The ability to start a discussion on any help-related topic with a single mouse click will be, I believe, extremely helpful for the users. The real aim of this project is to develop a repository of all information regarding sugar - much like StackOverflow - that be the go-to place for sugar users. That's why this project needs to be undertaken.
   −
The Discourse platform backend is made up entirely in Ruby. The sugar shell in made in Python. So, I'll mostly need to interact with Python and at times dabble with Ruby as well. The major tasks to be accomplished are:
+
The Discourse platform backend is made up entirely in Ruby. The sugar shell is made in Python. So, I'll mostly need to interact with Python and at times dabble with Ruby as well. The major tasks to be accomplished are:
    +
# Making a social-help activity based on WebKitGTK+ that would be similar to the browse activity.
 
# Getting the Discourse platform tweaked according to the needs of  sugar. This will include:
 
# Getting the Discourse platform tweaked according to the needs of  sugar. This will include:
 
## Getting the UI of Discourse match (at least to some extent) with that of sugar.
 
## Getting the UI of Discourse match (at least to some extent) with that of sugar.
Line 76: Line 77:  
##* The user will need to feed in the password.
 
##* The user will need to feed in the password.
 
# Developing an authentication bridge for use with Discourse. This is a topic of discussion. We've had some [http://lists.sugarlabs.org/archive/sugar-devel/2014-March/047498.html opinions posted on the mailing list]. All of these strategies can work - but, we need to decide on one of these. (I talked to Walter on IRC and he said to make this discussion a part of your project - maybe something to be done during the community bonding period). Here are the things we can do:
 
# Developing an authentication bridge for use with Discourse. This is a topic of discussion. We've had some [http://lists.sugarlabs.org/archive/sugar-devel/2014-March/047498.html opinions posted on the mailing list]. All of these strategies can work - but, we need to decide on one of these. (I talked to Walter on IRC and he said to make this discussion a part of your project - maybe something to be done during the community bonding period). Here are the things we can do:
## The first approach is to add two methods to the browse activity - a set_cookie and a get_cookie - the can be accessed via DBus by Sugar shell. Here's the workflow:
+
## The first approach is to add two methods to the social-help activity - a set_cookie and a get_cookie - these can be accessed via DBus by Sugar shell. Here's the workflow:
##* When user opens social help, we'll read the session cookies from a config file set it in the browser (unless the cookies are already set).
+
##* When user opens social help, we'll read the session cookies from a config file set it in the social-help activity (unless the cookies are already set).
##* When the user closes the browser, we check if the session cookie is set. If so, we overwrite the config file with this new cookie.
+
##* When the user closes the social-help activity, we check if the session cookie is set. If so, we overwrite the config file with this new cookie.
 
## The second approach is to log users in via facebook/google. This approach I do not like as it won't work in areas with only a local network. Also, I don't like the idea of tying this to a non-free (as in freedom) service.
 
## The second approach is to log users in via facebook/google. This approach I do not like as it won't work in areas with only a local network. Also, I don't like the idea of tying this to a non-free (as in freedom) service.
 
## The third approach could be similar to sugar webservices (facebook, putlocker etc.) The [http://lists.sugarlabs.org/archive/sugar-devel/2014-March/047530.html discussion on this is here].
 
## The third approach could be similar to sugar webservices (facebook, putlocker etc.) The [http://lists.sugarlabs.org/archive/sugar-devel/2014-March/047530.html discussion on this is here].
Line 93: Line 94:  
| 21st April - 19th May (Community Bonding Period) || Discuss which authentication bridge to use with Discourse.
 
| 21st April - 19th May (Community Bonding Period) || Discuss which authentication bridge to use with Discourse.
 
|-
 
|-
| 19th May - 26th May || Begin coding. Add the social help button to sugar menus.
+
| 19th May - 26th May || Begin coding. Add the social help button to sugar menus. Start working on the social-help activity.
 
|-
 
|-
| 26th May - 2nd June || Set up a local Discourse environment that can be launched from within sugar.
+
| 26th May - 2nd June || Complete the social-help activity. Set up a local Discourse environment that can be launched from within sugar via social-help.
 
|-
 
|-
 
| 2nd June- 9th June || Work on tweaking the Discourse styling to suit sugar.
 
| 2nd June- 9th June || Work on tweaking the Discourse styling to suit sugar.
 
|-
 
|-
| 9th June - 23rd June || Build the auth bridge. The way this would be done would depend on the approach chosen for this.
+
| 9th June - 23rd June || Build the auth bridge. The way this would be done would depend on the approach chosen for this. Likely however is that we'll add cookie based methods to social-help accessible via DBus
 
|-
 
|-
 
| 23rd June - 27th June || Iron out the kinks in the code developed till now for the midterm evaluation deadline.
 
| 23rd June - 27th June || Iron out the kinks in the code developed till now for the midterm evaluation deadline.
Line 105: Line 106:  
| '''Midterm Evaluation''' || '''''Milestone:''''' Show a working sugar shell that can launch into Discourse and get the user logged in.
 
| '''Midterm Evaluation''' || '''''Milestone:''''' Show a working sugar shell that can launch into Discourse and get the user logged in.
 
|-
 
|-
| 27th June - 4th July || Make a data migration script that can be used to set up Discourse locally with the data from a central DB.
+
| 27th June - 4th July || Make a data migration script that can be used to set up Discourse locally with the data from the central DB.
 
|-
 
|-
 
| 4th July - 11th July || Manually add all major possible topics to Discourse and populate it with data from the wiki and any other relevant sources.
 
| 4th July - 11th July || Manually add all major possible topics to Discourse and populate it with data from the wiki and any other relevant sources.
25

edits

Navigation menu