Difference between revisions of "Features/Social Help"

From Sugar Labs
Jump to navigation Jump to search
(Add social help page)
 
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
[[Category:Feature Page Incomplete]]
+
[[Category:FeatureLanded|.]]
[[Category:Feature|.]]
 
 
</noinclude>
 
</noinclude>
  
 
== Summary ==
 
== Summary ==
Social Help adds away for users to post questions on an open fourm for developers or other users to answer.
+
Social Help adds away for users to post questions on an open forum for developers or other users to answer.
  
 
== Owner ==
 
== Owner ==
 
* Name: [[User:Prasoon2211| Prasoon Shukla]]
 
* Name: [[User:Prasoon2211| Prasoon Shukla]]
 
* Email: <prasoon92.iitr AT gmail DOT com>
 
* Email: <prasoon92.iitr AT gmail DOT com>
 +
* Name:  [[User:SAMdroid|Sam P.]]
 +
* Email:  <samNOSPAM AT sugarlabs DOT org> Remove the <code>NOSPAM</code>
  
 
== Current status ==
 
== Current status ==
* Targeted release: 0.104
+
* Targeted release: 0.106
* Last updated: 3/Sep
+
* Last updated: 18/April/2015
 
* Percentage of completion: 75%
 
* Percentage of completion: 75%
  
 
== Detailed Description ==
 
== Detailed Description ==
To create an easily accessible, highly usable platform that sugar users can use to discuss, debate and share ideas about everything related to sugar.  It is a discourse forum , activity and item in the current activity palette.
+
To create an easily accessible, highly usable platform that Sugar users can use to discuss, debate and share ideas about everything related to Sugar.  It is a forum, activity and item in the current activity palette.
 +
 
 +
Sugar Labs provides a forum.  Using the Sugar Labs forum requires creating a forum account, which is offered on first use.
 +
 
 +
Alternative forums can be provided by deployments.  These forums must be designed for the purpose, and configured into the build of Sugar.
 +
 
 +
An alternative forum is configured by setting the ''social-help-server'' key in the ''org.sugarlabs.collaboration'' schema, for example by using a vendor override.  See also [http://dev.laptop.org/git/projects/olpc-os-builder/commit/?id=e5da9b3 olpc-os-builder] and [https://developer.gnome.org/gio/stable/GSettings.html GSettings].
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
 
Walter says:  People are social and learning is social. Having a forum for sharing ideas and help is invaluable -- especially in light of the decentralized nature of the Sugar community. While the developer community is comfortable with IRC, we have not been successful in getting our user community to use it: they are seeming more comfortable with web tools (e.g. there is a large community of teachers using Facebook to discuss Sugar.) It would of course be better to have a FOSS solution. But also one that didn't require a lot of maintenance and support by the Sugar developer community. Hence, a connection to an existing FOSS platform would be attractive.  
 
Walter says:  People are social and learning is social. Having a forum for sharing ideas and help is invaluable -- especially in light of the decentralized nature of the Sugar community. While the developer community is comfortable with IRC, we have not been successful in getting our user community to use it: they are seeming more comfortable with web tools (e.g. there is a large community of teachers using Facebook to discuss Sugar.) It would of course be better to have a FOSS solution. But also one that didn't require a lot of maintenance and support by the Sugar developer community. Hence, a connection to an existing FOSS platform would be attractive.  
  
Prasoon says:  If this project is successfully completed, the users will have instant access to a discussion platform on which they can ask any question related to sugar. Over time, this information will develop itself into a repository of information where most common questions related to the platform would be present. This repository of information will be hugely beneficial for the sugar community.  
+
Prasoon says:  If this project is successfully completed, the users will have instant access to a discussion platform on which they can ask any question related to Sugar. Over time, this information will develop itself into a repository of information where most common questions related to the platform would be present. This repository of information will be hugely beneficial for the Sugar community.  
  
 
Sai Vineet says:  There is currently no way to get instant help from real people from inside Sugar, except the IRC activity, which sadly is too complicate and distributed(hard to find stuff which one needs, no logs, there are security problems). We really need a way to get children help quickly, and this is what this project will give us. It will, with time, also become a full help repository, and also a way for children to talk and discuss things in a more social manner than it is now. Thus the Social Help project is invaluable to Sugar and it's vision, that learning is a social process.  
 
Sai Vineet says:  There is currently no way to get instant help from real people from inside Sugar, except the IRC activity, which sadly is too complicate and distributed(hard to find stuff which one needs, no logs, there are security problems). We really need a way to get children help quickly, and this is what this project will give us. It will, with time, also become a full help repository, and also a way for children to talk and discuss things in a more social manner than it is now. Thus the Social Help project is invaluable to Sugar and it's vision, that learning is a social process.  
  
 
== Scope ==
 
== Scope ==
It is just an activity and a menu item... not tooo big.  Look at the pr:  https://github.com/sugarlabs/sugar/pull/391
+
The old design is just an activity and a menu item... not too big.  Look at the [https://github.com/sugarlabs/sugar/pull/391 pull request #391].
  
We will also need hosting from SL, but Bernie has okayed it... [[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) I will get it up and running once Bernie gives me an account.
+
The new design is a menu item and a popup.
  
==UI Design==
+
The forum is hosted on Sugar Labs server ''freedom''.  See the service page ([[Service/Social Help]]).
Adds a thing in the activity palette, but that isn't too bigThere will need to be a logo for the social help fourm and activity.
 
  
 +
==User Interface Design==
 +
[[File:Social-help-design-3.png|alt=Social Help popup|none|thumb|454x454px|Social Help popup]]
 +
[[File:Social-help-settings-view.png|alt=Social Help section in the Network settings|none|thumb|453x453px|Social Help section in the Network settings]]
 +
This adds a view-switcher in the help view to let users view social help.
 +
 +
This adds an extra configuration item in the settings.
 
== How To Test ==
 
== How To Test ==
 
+
# Apply the patches,
1.  Download the pr
+
# Start TurtleBlocks (for example),
2.  Start an activity
+
# Open the frame, right click the activity icon, and click the help menu item (or type Alt-Shift-H),
3.  Start social help for that activity
+
# Select the social help option.
  
 
== User Experience ==
 
== User Experience ==
Line 44: Line 56:
  
 
== Dependencies ==
 
== Dependencies ==
It depends on the social help activity (another browse clone):  https://github.com/prasoon2211/sugar-social-help
+
New design:  SoupGNOME (already a [[Activities/Browse|Browse]] dependency)
 +
 
 +
Old design:  It depends on the social help activity (another browse clone):  https://github.com/prasoon2211/sugar-social-help
  
 
== Contingency Plan ==
 
== Contingency Plan ==
[[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) Why does this even exsist in the template?
+
This is not a blocker.
 
+
== Release Note ==
* Use IRC
+
Added Social Help. Social Help lets users connect with each other and developers to fix bugs, get help and discuss activities.
*  Ask people IRL
 
*  Just host a fourm and tell everyone the link
 
  
== Release Notes ==
+
Include video summary link, if updated by release time ([https://www.youtube.com/watch?v=_WzwVZ60Tbw old version])
''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.''
 
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
  
* See the github pr:  https://github.com/sugarlabs/sugar/pull/391
+
* Latest patch:    https://github.com/sugarlabs/sugar/pull/494
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
+
* Design 2 patch:  https://github.com/sugarlabs/sugar/pull/483
 +
* Design 1 patch:  https://github.com/sugarlabs/sugar/pull/391
 +
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Latest revision as of 10:49, 21 July 2015


Summary

Social Help adds away for users to post questions on an open forum for developers or other users to answer.

Owner

  • Name: Prasoon Shukla
  • Email: <prasoon92.iitr AT gmail DOT com>
  • Name: Sam P.
  • Email: <samNOSPAM AT sugarlabs DOT org> Remove the NOSPAM

Current status

  • Targeted release: 0.106
  • Last updated: 18/April/2015
  • Percentage of completion: 75%

Detailed Description

To create an easily accessible, highly usable platform that Sugar users can use to discuss, debate and share ideas about everything related to Sugar. It is a forum, activity and item in the current activity palette.

Sugar Labs provides a forum. Using the Sugar Labs forum requires creating a forum account, which is offered on first use.

Alternative forums can be provided by deployments. These forums must be designed for the purpose, and configured into the build of Sugar.

An alternative forum is configured by setting the social-help-server key in the org.sugarlabs.collaboration schema, for example by using a vendor override. See also olpc-os-builder and GSettings.

Benefit to Sugar

Walter says: People are social and learning is social. Having a forum for sharing ideas and help is invaluable -- especially in light of the decentralized nature of the Sugar community. While the developer community is comfortable with IRC, we have not been successful in getting our user community to use it: they are seeming more comfortable with web tools (e.g. there is a large community of teachers using Facebook to discuss Sugar.) It would of course be better to have a FOSS solution. But also one that didn't require a lot of maintenance and support by the Sugar developer community. Hence, a connection to an existing FOSS platform would be attractive.

Prasoon says: If this project is successfully completed, the users will have instant access to a discussion platform on which they can ask any question related to Sugar. Over time, this information will develop itself into a repository of information where most common questions related to the platform would be present. This repository of information will be hugely beneficial for the Sugar community.

Sai Vineet says: There is currently no way to get instant help from real people from inside Sugar, except the IRC activity, which sadly is too complicate and distributed(hard to find stuff which one needs, no logs, there are security problems). We really need a way to get children help quickly, and this is what this project will give us. It will, with time, also become a full help repository, and also a way for children to talk and discuss things in a more social manner than it is now. Thus the Social Help project is invaluable to Sugar and it's vision, that learning is a social process.

Scope

The old design is just an activity and a menu item... not too big. Look at the pull request #391.

The new design is a menu item and a popup.

The forum is hosted on Sugar Labs server freedom. See the service page (Service/Social Help).

User Interface Design

Social Help popup
Social Help popup
Social Help section in the Network settings
Social Help section in the Network settings

This adds a view-switcher in the help view to let users view social help.

This adds an extra configuration item in the settings.

How To Test

  1. Apply the patches,
  2. Start TurtleBlocks (for example),
  3. Open the frame, right click the activity icon, and click the help menu item (or type Alt-Shift-H),
  4. Select the social help option.

User Experience

They will be able to access easy help from the developers and community.

Dependencies

New design: SoupGNOME (already a Browse dependency)

Old design: It depends on the social help activity (another browse clone): https://github.com/prasoon2211/sugar-social-help

Contingency Plan

This is not a blocker.

Release Note

Added Social Help. Social Help lets users connect with each other and developers to fix bugs, get help and discuss activities.

Include video summary link, if updated by release time (old version)

Comments and Discussion