Sugar Labs - User contributions [en]

Features/Sugar3 Docs

2017-01-03T04:07:58Z

SAMdroid: /* Example Docstring */ Example doc string should have correct format

[[Category:Feature|.]]

== Summary ==
Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your browser.

== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: @sam.today

== Current status ==
* Targeted release: 0.108
* Last updated: 8/Aug
* Percentage of completion: 10% (see [https://developer.sugarlabs.org/sugar3/ documentation website])

== Detailed Description ==
* Create a sphinx configuration file so we can have a website (DONE)
* Translate existing docs into 1 consistent style
* Write docs for all other public ''sugar3'' classes, see [[/How To Write]]

=== Example Docstring ===

Let's just use google style doc strings, they are very clean and simmilar to the current style. [http://sphinx-doc.org/ext/example_google.html#example-google Longer example.]

<nowiki>
# GPLv3...
'''
The module does something which should be summarised here.

Example:
Something representitive of the overall module::

from example import ClassyClass

# Explain non-obvious behaviour
c = ClassyClass(a=1, b=2)
c.props.c = 3
c.thing()

STABLE.
'''

from gi.repository import GObject

class ClassyClass(GObject.GObject):
'''
The ClassyClass does blah, blah. Explain common usage pattern of
this class, such as calling the `thing` function to do a thing.

The `lol` signal is emitted when the class is laughing or when a
different non-obvious condition happens.

Args:
a (int): description of a
b (int): b could be a contrustor argument or a GObject props
that you can invoke using the **kwargs
c (int): desctiption of c
d (sugar3.graphics.alert.Alert): remember to link
classes using the correct syntax

.. code-block:: python

c = ClassyClass()
# This is just an example of using this class
'''

def __init__(self, **kwargs):
GObject.GObject.__init__(self, **kwargs)

def thing(self, happy, lol=False):
'''
What a description for this function!

Args:
happy (bool): a description for happy

Keyword Arguments:
lol (bool): a optional argument, explain what
it defaults to

Returns:
type: explaintaion
'''
pass
</nowiki>

== Benefit to Sugar ==
This will allow developers to create activities more eaisly. They will no longer have to look thought the source code th understand how the api works, they will instead (hopefully) have understandable docs with good working code samples.

== Scope ==
This will require lots of changes in the docstrings. However, no changes will be made to code that runs on users machines.

==UI Design==
Example docs: http://dev.sam.today/ http://dev.sam.today/sugar3.graphics.alert/ http://dev.sam.today/sugar3.graphics.animator/

== How To Test ==
* View docs
* Try code samples

== User Experience ==
None for sugar users.

== Dependencies ==
None

== Contingency Plan ==
None

== Release Notes ==
The Sugar toolkit now has imporved API documentation coverage. View our docs here: dev.sam.today (real url when it is done of course)

== Comments and Discussion ==

* https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/248
* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Service/Social Help

2016-11-22T06:07:37Z

SAMdroid: /* Setup */

== Hostnames & Emails ==

[https://socialhelp.sugarlabs.org socialhelp.sugarlabs.org]

[http://use.socialhelp.sugarlabs.org use.socialhelp.sugarlabs.org] (HTTP only, redirects to use-socialhelp on https)

[https://use-socialhelp.sugarlabs.org use-socialhelp.sugarlabs.org]

socialhelp AT sugarlabs DOT org

== Hosted On ==

[[Machine/justice|Freedom]] using docker

All the stuff lives in <code>/srv/socialhelp</code>

It uses the <code>socialhelp</code> partition which is 20G ext4 on the lvm

== Setup ==

First do the discourse:

cd /srv/socialhelp/discourse

<nowiki>#</nowiki> Generate the container - will take some time
sudo ./launcher rebuild app

sudo ./launcher start app --docker-args "-m 5g --cpuset='6-7'"
Most of the helpful discourse documentation is found [https://meta.discourse.org/t/how-do-i-update-my-docker-image-to-latest/23325 on their discourse forum].

Then the re-director & sso:

container.yml start /containers/org.sugarlabs.socialhelp_sso/ -d
container.yml start /containers/org.sugarlabs.use-socialhelp/ -d

# If they fail to start, make sure that they are built:
container.yml build /containers/org.sugarlabs.socialhelp_sso/
container.yml build /containers/org.sugarlabs.use-socialhelp/

Service/New ASLO

2016-07-14T22:07:52Z

SAMdroid: New aslo is not running any more

'''The New ASLO is not a running anymore. This page is only historical information.'''

== Hostnames & Emails ==

[https://activities-2.sugarlabs.org activities-2.sugarlabs.org] (and [https://aslo.cf aslo.cf] is a redirect, along with activities2.sl.o)

[https://hook.sugarlabs.org hook.sugarlabs.org] (old subdomain, now alias: [https://aslo-bot-master.sugarlabs.org aslo-bot-master.sugarlabs.org])

== Hosted On ==

[[Machine/justice|Freedom]] using docker & nginx

[[Machine/sunjammer|Sunjammer]] hosts the bundles. It also has a webhook/cgi-script to pull the bundles from rsync://freedom.sugarlabs.org/activities2

=== Ports ===

Bot Master: 5001 (on freedom)

== Setup ==

Most services depend on the kafka queue. It is configured via docker-compose in <code>/home/sam/kafka-docker</code>.

Powered by docker containers. Setup requires is running the container.yml files found in the subdirectories of the [https://github.com/samdroid-apps/aslo ASLO repo]. Eg:

container.yml start /home/sam/bot -d
You also want to have the [[Service/Social Help|social help service]] running as well for the comments system.

Features/Tick based animation

2016-06-18T11:29:48Z

SAMdroid: Merged

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]
</noinclude>

== Summary ==
Smoother Animations.

Animate each frame as Gtk+ needs a new frame drawn instead of at whatever frame rate we want.

== Owner ==
* Name: Sam P.
* Email: *@sam.today

== Current status ==
* Merged in 0.109.0.1
* Last updated: 18 June 2016
* Percentage of completion: 100% MERGED

== Detailed Description ==
Gtk+ 3.8 introduces the idea of a 'tick'. This can have a callback attached to it. This is used to do animations in GtkPopover and the other Gtk+ widgets that have animations. Therefore, sugar should not just do out animations at 20fps. If the animation could go at 120fps because the computer is awesome, why not? If the computer is bad and it can only render 5fps, why worry about any more?

This feature can be split up into many parts:

* Toolkit implementation (100%): https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/213
* Frame and Home view (100%): https://github.com/sugarlabs/sugar/pull/505 Frame and homeview are a good spot for tick based animation as we are not cpu bound to open the frame or change views - the animation can take up 100% cpu and all will be fine
* Pulsing icon (NO-GO): https://github.com/sugarlabs/sugar/pull/513 Opening an activity is a cpu bound task, so this is probably the wrong space for animations that steal all of the cpu. This patch TRIPLES activity start times on the XO4.

== Benefit to Sugar ==
Smoother animation.

No legit, that is the only benefit.

== Scope ==
Animation consumers need to add the "widget=x" when creating an animator so they can have the tick callback attached.

Consumers who don't are not effected.

==UI Design==
None

== How To Test ==

https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/258#issuecomment-145695297

== User Experience ==
Smoother animations.

== Dependencies ==
Needs Gtk 3.8 to look different.

== Contingency Plan ==
None necessary, revert to previous release behaviour

== Documentation ==
Included in the toolkit patch

== Release Notes ==
Animations are now smoother than ever on newer hardware. Animations dynamically change FPS to leave no cpu cycle wasted.

== Comments and Discussion ==

https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/258
https://github.com/sugarlabs/sugar/pull/572

0.110/Feature List

2016-06-05T01:02:13Z

SAMdroid:

== Done ==

* [[Features/Proxy_Settings]]
* Added the "sugar-erase-bundle" script https://github.com/sugarlabs/sugar/pull/687/files [[User:Quozl]]
* Turned off Metacity compositing [[User:Quozl]]
* Add a new PopWindow module for developers https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/313#issuecomment-223776873 Abhijit Patel

== Ideas ==

* [[0.110/Feature List/Sugar ScreenshotDialogPopup|Screenshot Dialog Popup]]
* [[0.110/Feature_List/JS_Fiddler|Browse JS fiddler]]
* [[Features/Replace_GtkMenu|Replace Gtk Menu]] https://github.com/sugarlabs/sugar/pull/567
** Note, no one has adopted this
* https://bugs.sugarlabs.org/ticket/4900 https://github.com/sugarlabs/sugar/pull/609
* [[Features/FreeDesktop integration|Better integrate with X11 FreeDesktop]]
* Faster UI perception (especially on XO-1)
** <nowiki>https://github.com/sugarlabs/sugar/pull/619</nowiki> was closed, pending design discussion

* <nowiki>http://wiki.sugarlabs.org/go/Lion_Activity</nowiki>

0.110/Feature List

2016-06-04T12:40:57Z

SAMdroid:

== Done ==

* [[Features/Proxy_Settings]]
* Added the "sugar-erase-bundle" script https://github.com/sugarlabs/sugar/pull/687/files [[User:Quozl]]
* Turned off Metacity compositing [[User:Quozl]]

== Ideas ==

* [[0.110/Feature List/Sugar ScreenshotDialogPopup|Screenshot Dialog Popup]]
* [[0.110/Feature_List/JS_Fiddler|Browse JS fiddler]]
* [[Features/Replace_GtkMenu|Replace Gtk Menu]] https://github.com/sugarlabs/sugar/pull/567
** Note, no one has adopted this
* https://bugs.sugarlabs.org/ticket/4900 https://github.com/sugarlabs/sugar/pull/609
* [[Features/FreeDesktop integration|Better integrate with X11 FreeDesktop]]
* Faster UI perception (especially on XO-1)
** <nowiki>https://github.com/sugarlabs/sugar/pull/619</nowiki> was closed, pending design discussion

* <nowiki>http://wiki.sugarlabs.org/go/Lion_Activity</nowiki>

0.110/Roadmap

2016-05-26T23:48:23Z

SAMdroid: Add COPR url

<noinclude>{{TeamHeader|Development Team|home=Development Team Home|roadmap_link={{Upcoming Stable Release}}/Roadmap}}
[[Category:Roadmap]]
</noinclude>

== About ==

Sucrose 0.109.x is an unstable development series intended for testing and development purposes. Sucrose uses odd minor version numbers to indicate development status, so an unstable 0.109.x series will finally become the 0.110 stable release.

== Testing ==

Fedora 23/24/rawhide: https://copr.fedorainfracloud.org/coprs/samtoday/sugar/

== Goals ==

* Improve stability (especially for collaboration).
* Make Sugar shine on Gtk+ 3.20+.
* Merge GSoC student features.

== Schedule ==

{| cellpadding="10" cellspacing="0" border="1"
!Date
!Task
!Comments
|-
|29 May 2016
|Sucrose 0.109.0.0 unstable tarballs & release
|Initial release (kick-off). Automate COPR, etc.
|-
|Continuous (at merger of large features)
|Sucrose 0.109.0.x unstable tarballs & release
|Development and testing releases.
|-
|15 August 2016
|Sucrose 0.109.1.0 unstable tarballs & release
|Features freeze
|-
|1 September 2016
|Sucrose 0.109.2.0 unstable tarballs & release
|Strings, UI, API freeze
|-
|18 September 2016
|Sucrose 0.109.2.1 unstable tarballs & release
|Development and testing release.
|-
|1 October 2016
|Sucrose 0.110.0 stable tarballs & release
|Final release
|-
|}

== Freezes ==

{| cellpadding="10" cellspacing="0" border="1"
!Date
!Freeze
|-
|15 August 2016
|[[Development_Team/Release#Feature_freeze | Feature]]
|-
|29 August 2016
|Leeway to catch up with Gtk+ changes (Gtk+ feature freeze is 15 August 2016)
|-
|1 September 2016
|[[Development_Team/Release#String_freeze | String]], [[Development_Team/Release#UI_Freeze | UI]], API
|-
|1 October 2016
|[[Development_Team/Release#Hard_code_freeze | Code]]
|}

0.110/Roadmap

2016-05-26T22:13:14Z

SAMdroid: Add timeline

<noinclude>{{TeamHeader|Development Team|home=Development Team Home|roadmap_link={{Upcoming Stable Release}}/Roadmap}}
[[Category:Roadmap]]
</noinclude>

== About ==

Sucrose 0.109.x is an unstable development series intended for testing and development purposes. Sucrose uses odd minor version numbers to indicate development status, so an unstable 0.109.x series will finally become the 0.110 stable release.

== Goals ==

* Improve stability (especially for collaboration).
* Make Sugar shine on Gtk+ 3.20+.
* Merge GSoC student features.

== Schedule ==

{| cellpadding="10" cellspacing="0" border="1"
!Date
!Task
!Comments
|-
|29 May 2016
|Sucrose 0.109.0.0 unstable tarballs & release
|Initial release (kick-off). Automate COPR, etc.
|-
|Continuous (at merger of large features)
|Sucrose 0.109.0.x unstable tarballs & release
|Development and testing releases.
|-
|15 August 2016
|Sucrose 0.109.1.0 unstable tarballs & release
|Features freeze
|-
|1 September 2016
|Sucrose 0.109.2.0 unstable tarballs & release
|Strings, UI, API freeze
|-
|18 September 2016
|Sucrose 0.109.2.1 unstable tarballs & release
|Development and testing release.
|-
|1 October 2016
|Sucrose 0.110.0 stable tarballs & release
|Final release
|-
|}

== Freezes ==

{| cellpadding="10" cellspacing="0" border="1"
!Date
!Freeze
|-
|15 August 2016
|[[Development_Team/Release#Feature_freeze | Feature]]
|-
|29 August 2016
|Leeway to catch up with Gtk+ changes (Gtk+ feature freeze is 15 August 2016)
|-
|1 September 2016
|[[Development_Team/Release#String_freeze | String]], [[Development_Team/Release#UI_Freeze | UI]], API
|-
|1 October 2016
|[[Development_Team/Release#Hard_code_freeze | Code]]
|}

0.110/Feature List

2016-05-09T11:04:31Z

SAMdroid:

Done
====

* [[Features/Proxy_Settings]]

Ideas
====

* [[0.110/Feature List/Sugar ScreenshotDialogPopup|Screenshot Dialog Popup]]
* [[Features/Replace_GtkMenu|Replace Gtk Menu]] https://github.com/sugarlabs/sugar/pull/567
** Note, no one has adopted this
* https://bugs.sugarlabs.org/ticket/4900 https://github.com/sugarlabs/sugar/pull/609
* [[Features/FreeDesktop integration|Better integrate with X11 FreeDesktop]]
* Faster UI perception (especially on XO-1)
** <nowiki>https://github.com/sugarlabs/sugar/pull/619</nowiki> was closed, pending design discussion

* <nowiki>http://wiki.sugarlabs.org/go/Lion_Activity</nowiki>

Features/Proxy Settings

2016-05-09T11:02:13Z

SAMdroid: Merged!

<noinclude>
[[Category:Feature|Proxy Settings]]
</noinclude>

== Summary ==

Allow the user to configure proxy settings using the Sugar Control Panel.

== Owner ==

[[User:sascha_silbe|Sascha Silbe]], [[User:ajay_garg|Ajay Garg]] (ajay@activitycentral.com), [[User:ManashRaja|Manash Pratim Das]]

== Current status ==

* Targeted release: 0.110
* Last updated: 2016-04-18
* Percentage of completion: 100% and merged

Merged into something that will probably be 0.110

== Detailed Description ==

Both individual users and deployments need to be able to set a proxy for
Sugar and activities to use. While we'd like the system to work that all
out automatically (e.g. using [https://en.wikipedia.org/wiki/Web_Proxy_Autodiscovery_Protocol WPAD]), this often isn't possible. Common
reasons include legacy ("inherited") setups and network uplinks being
out of control of the user.

The existing Network Control Panel is enhanced by adding a new section for the
proxy settings. For consistency between Sugar and Gnome, the basic layout of
the Gnome 3 proxy settings has been mirrored: A combo box allows the user to
select how the proxy setting should be determined (None=no proxy settings,
Use system proxy=let proxy be set by other means, Automatic=WPAD or PAC,
Manual=enter host names and ports for each protocol).
Based on which method was selected, additional configuration options are
presented to the user.

The settings are stored in 'GSettings' and passed to activities using the 'http_proxy' and similar variables.

== Benefit to Sugar ==

Widens the environment where Sugar may be used, by removing a reason why Sugar cannot be used in managed information technology environments.

== Scope ==

Modifying the existing Network Control Panel.

== "Manual" mode==

* Fill in the settings "manually", and restart when prompted so.
:[[File:Manual1-proxy.png|1200px]]

* Now open "www.google.com" shoud open.
:[[File:Google-proxy.png|1200px]]

== Automatic mode - PAC==

* Fill in the URL of the proxy-file, and restart when prompted so.
:[[File:Auto-proxy.png|1200px]]

* Now open "www.google.com" shoud open.
:[[File:Google-proxy.png|1200px]]

==Automatic mode - WPAD==

* Motive
** To provide proxy-configuration, without needing the client-user
*** to manualyy enter the proxy-settings ('''Manual''' mode)
*** to manually enter the location of proxy-configuration file herself ('''Automatic (PAC)''' mode).

* Benefits
** By not needing the client-user to manually specify the settings, every client-user is saved a headache :) Instead, all the configuration is done via a network-administrator, on the server-side.
** By delegating the responsibility of specifying every proxy-rule (even the proxy-configuration file) to the network-administrator, security is increased dramatically.

* Notes
** Setting this particular mode ('''Automatic-WPAD''' Proxy) is quite complicated; and many possibilities exist. '''However, the bottom-rule is, client should himself not need to specifiy the location of proxy-configuration file as per say'''.

* Testing (one of the possible ways :) )
** '''(For those not interested in the technicalities, please proceed to the next bullet :D)''' To verify that current dextrose-4 supports Auto-WPAD mode, we test using the method, as per the following 4 requirements, as listed at http://en.wikipedia.org/wiki/Web_Proxy_Autodiscovery_Protocol#Requirements ::
***In order to use the DNS only method, a DNS entry is needed for a host named WPAD.
***The host at the WPAD address must be able to serve a Web page.
***In both cases, the Web server must be configured to serve the WPAD file with a MIME type of "application/x-ns-proxy-autoconfig".
***If the DNS method is used, a file named wpad.dat must be located in the WPAD Web site's root directory.

* Select "Automatic" mode in "My Settings" -> "Proxy" (without specifying anything else), and restart when prompted so.
:[[File:Wpad-proxy.png|1200px]]

* The above step is all that is needed for "Automatic (WPAD)" mode to take effect; the WPAD-configuration-file will be located by the DHCP/DNS Server. However, for easy QA testing, we specify an easy way to replicate this DNS behavior ::

** Add the line "build.activitycentral.com wpad" to the file "/etc/hosts" on the XO, and reboot. '''It is repeated innumerable times, that this step is required just for easy testing; in actual deployments, the DNS-name resolution will be provided by network-administrators/School-Server-running-DHCPD'''
** Also, thanks a ton to '''Santiago Rodriguez (scollazo@activitycentral.com)''' for setting up the proxy-configuration-files at build.activitycentral.com.

* Open "Browse", and type in "www.google.com". You should be prompted for credentials (suppose as required by the WPAD-configuration-file)

:[[File:proxy2.png|640px]]

* Entering wrong credentials in the previous step, re-prompts :). This time, enter correct credentials.
:[[File:proxy3.png|640px]]

* The page opens successfully.
:[[File:Google-proxy.png|1200px]]

==Settings verification==

The proxy settings entered by user are verified before saving to prevent accidental change in proxy settings.
* For "manual" type the proxy host addresses are pinged to check for their existence.
* For "auto" type the existence of the *.pac file is checked.
If the above verification fails then the user is prompted with an alert message and option to either "Break the Internet connection" or "Reset".

* Manual proxy verification failed:
:[[File:Manual-proxy-error.png|640px]]

* Auto proxy verification failed:
:[[File:Auto-proxy-error.png|640px]]

== User Experience ==

See [[#UI Design|UI Design]]

== Dependencies ==

There are no new dependencies.

== Contingency Plan ==

Users can continue to use the Gnome Control Center to configure proxy settings.

== Documentation ==

There is no documentation beyond this page.

== Release Notes ==

There have been no changes to public API. The Release Notes merely need to mention that users can now configure proxy settings from within Sugar. As detailed above, the UI is very similar to the Gnome UI.

== Comments and Discussion ==
* See [[{{TALKPAGENAME}}|discussion tab for this feature]]

0.110/Feature List

2016-04-03T04:43:48Z

SAMdroid:

* [[0.110/Feature List/Sugar ScreenshotDialogPopup|Screenshot Dialog Popup]]
* [[Features/Replace_GtkMenu|Replace Gtk Menu]] https://github.com/sugarlabs/sugar/pull/567 -> Note, feel free to adopt this if you want it to actually get done
* https://bugs.sugarlabs.org/ticket/4900 https://github.com/sugarlabs/sugar/pull/609

Summer of Code/2016

2016-02-20T00:03:40Z

SAMdroid: Add a groups rethink idea

'''Students''': See our guide on [[Summer_of_Code#How_to_participate|how to participate in Google Summer of Code]] for more information.

== Project candidates ==

In the table below is a list of projects potential participants might contribute to in the GSoC program.

;Note 0: These are project ideas from Sugar Labs contributors. '''Students, feel free to propose your ideas as well.'''
;Note 1: Potential mentors, please feel free to add ideas to this list. Also, feel free to add your name to a project you'd be willing to co-mentor.
;Note 2: Potential students, more project ideas can be found on our [[Features]] page.

== Sugar Core ==

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! !! Title !! Mentor !! Project
|-
!valign=top | [[File:Journal-12.jpeg|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Journal Rethink ||valign=top width="15%" | Sam Parkinson ||align=left valign=top|
;Brief explanation: The Sugar Journal could be rethought to add more emphasis on collaboration, or adding more organisational support for creating "projects" among other things.
;Expected results: Working code for the journal and vague ideas (more concrete than this) defined ahead of time.
;Knowledge prerequisite: Strong background in Python and knowledge of Gtk+.
|-
!valign=top | [[Image:Sugarlabs_mainpage_01.png|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" | Groups Rethink ||valign=top width="15%" | Sam Parkinson ||align=left valign=top|
;Brief explanation: Sugar has a buddies/group zoom view, which is very limited. It could be further integrated with sugar (eg. send to group, share with group, have a shared group journal) and expanded upon (having multiple groups user configured, like: a science prac group, a drama play group, etc.).
;Expected results: Working code for the Sugar and vague ideas (more concrete than this) defined ahead of time.
;Knowledge prerequisite: Strong background in Python and knowledge of Gtk+. Knowledge of telepathy is might be helpful.

|-
!valign=top | [[File:reflect.png|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Reflection Activity||valign=top width="15%" | Sam Parkinson and Walter Bender ||align=left valign=top|
;Brief explanation: The Sugar Journal is designed to be a place of reflection. We have the basic stub of a reflection activity that attempts to encourage more reflection and as a vehicle for sharing criticism. This idea needs more thought and coding.
;Expected results: A solid formulation of how the activity will work in the classroom and working code for the Reflection Activity.
;Knowledge prerequisite: Strong background in Python and knowledge of Gtk+.

|-
!valign=top | [[File:git_logo.png|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Git backend||valign=top width="15%" | Martin Abente Lahaye and Walter Bender ||align=left valign=top|
;Brief explanation: The Sugar Journal doesn't do a great job of supporting versioning or forking. This project is to build a backend for the Journal that is based on git, which does support versioning and forking. By building on top of a git hosting site we get the added benefit of network access as well.
;Expected results: Working code and an integration with Turtle Blocks
;Knowledge prerequisite: Strong background in Git and scripting languages such as Python, Ruby and JavaScript.

|-
!valign=top | || valign=top style="background:#e3e4e5;" | Performance tuning on machines with limited memory || valign=top | Samuel Greenfeld and James Cameron||align=left valign=top |
;Brief explanation: The newer Sugar builds have performance issues on some old hardware with limited memory. This is keeping some Sugar deployments from upgrading. This project is to look into the performance issues and tune Sugar for low-memory devices.
;Expected results: build suitable for running on OLPC XO-1 hardware
;Knowledge prerequisite:

|-
!valign=top | || valign=top style="background:#e3e4e5;" | Re-design collaboration with web technologies || valign=top | Martin Abente Lahaye and Walter Bender ||align=left valign=top |
;Brief explanation: Now that JavaScript has become a first class citizen in the Sugar ecosystem, we must re-design our collaboration model to allow collaboration between web activities regardless of the platform.
;Knowledge prerequisite: JavaScript, web sockets, web services.
|}

== Sugar Activities ==

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! !! Title !! Mentor !! Project

|-
!valign=top | [[File:confusion.png|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Beyond Flashcards: Programming to ReadJS||valign=top width="15%" | Walter Bender||align=left valign=top|
;Brief explanation: Back in the 1980s, IBM had a literacy program, "Writing to Read". The gist was that writing was a great way to spark a child's interest in reading. What if writing code could achieve a similar result? The project is to explore how programming might be incorporated into a literacy program. Like turtle, only simple sentences instead of stacks. It would be a "whole word" approach rather than a "phonics" approach: they can take "sentences" and make paragraphs that result in animations.
;Expected results: Working prototype
;Knowledge prerequisite: Strong background in Python or JavaScript

|-
!valign=top | ||valign=top width="15%" style="background:#e3e4e5;" | Covert Record, Clock, Speak and Measure to gstreamer 1.0 ||valign=top width="15%" | <TBD> ||align=left valign=top|
;Brief explanation: The vast majority of Activities that use gstreamer for sound have been converted to gstreamer 1.0 because the older 0.10 is now End of Life and is no longer being developed. It also adds quite a large set of extra duplicate dependencies to Sugar distributions. There's a lot of good examples of Activities that have been converted to provide excellent examples. The gstreamer 1.0 bindings are provided by gobject-introspection so it also assists in the conversion of Activities to gtk3.
;Expected results: As many of the above Activities converted to use gst 1.0
;Knowledge prerequisite: Strong background in Python, gobject-introspection and gstreamer

|-
!valign=top | ||valign=top width="15%" style="background:#e3e4e5;" | Covert TamTam to Csound6 ||valign=top width="15%" | <TBD> ||align=left valign=top|
;Brief explanation: TamTam makes extensive use of CSound, other Activities like Memorize, Pippy, and TurtleBlocks also can make use of CSound bindings. With the introduction of CSound 6 to a number of distributions TamTam needs migration to use the newer version of CSound.
;Expected results: Convert TamTam to use CSound6, possibly other Activities
;Knowledge prerequisite: Strong background in Python, background in CSound

|}

== Sugar Activities (and Ports) ==

These are existing and new activities we'd like to see enhanced. We expect that the activities will take on new UI features and pedagogical significance.

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! !! Title !! Mentor !! Project

|-
!valign=top | [[File:Music-Blocks.png|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Music Blocks Challenges||valign=top width="15%" | Devin Ulibarri||align=left valign=top|
;Brief explanation: Development of the "Power Piece" concept for teaching music and programming. (Power Pieces introduce rich musical ideas that can be studied, analyzed, transformed, and re-imagined, they are ripe for open-ended explorations.)
;Expected results: A well-documented series of activities for exploring musical and programming concepts using the Music Blocks activity as a foundation.
;Knowledge prerequisite: Strong background in Javascript, Music Theory
|-
!valign=top | [[File:Nutrition-icon.svg|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Nutritional Microworld||valign=top width="15%" | w/Dr. Jessica Early||align=left valign=top|
;Brief explanation: We have the basic building blocks (Turtle Nutrition) for programming with food as a datatype. What we are missing is a collection of meaningful activities to use with the tool as exemplars. We want to develop a an open-ended, yet
relevant tool—one that invites learners to explore fundamental concepts of nutrition that are both intrinsic to music yet transcendent of a specific discipline.
;Expected results: A well-documented series of activities for exploring nutrition that use the nutrition plugin as a basis. A series of workshops to study these ideas with children.
;Knowledge prerequisite: Strong background in Javascript, some background in Nutrition.
|-
!valign=top | [[File:Turtle-Flags.png|90px|thumb|center]] ||valign=top width="15%" style="background:#e3e4e5;" |Turtle Confusion/Flags JS||valign=top width="15%" | Walter Bender||align=left valign=top|
;Brief explanation: Port of Turtle Confusion and Turlte Flags.
;Expected results: A framework for creating challenges and a few exemplars.
;Knowledge prerequisite: Strong background in Javascript

|}

== Sugar Technology ==

Sugar is based on the Python programming language and the GTK libraries. We also support some web technologies: HTML5, CSS, and JavaScript.

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! !! Title !! Mentor !! Project

|-
| || Unit Testing || TBD || Deep dive into unit tests. We have a framework but it provides scant coverage for Sugar core and almost no coverage for Sugar activities.
;Brief Description: The goal is to develop tests for many more subsystems in Sugar core and to light a fire under the developer community to write tests for Sugar activities.
;Expected Results: a new test suite and scads of documentation.
;Knowledge Prerequisite: A strong background in Python.
|}

==Subpages==
{{Special:PrefixIndex/{{PAGENAMEE}}/}}

Summer of Code/2016

2016-02-16T20:56:10Z

SAMdroid: Add a journal project idea

Obsolete Service/znc

2016-01-18T10:29:33Z

SAMdroid: This service is down

**THIS SERVICE IS INACTIVE AND HAS BEEN FOR MONTHS**

Funny enough, no complaints yet!

It should be migrated to the majestic, yet-to-be-documented container.yml setup.

Thanks,
[[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) 05:29, 18 January 2016 (EST)

== Hostnames & Emails ==

None yet

== Hosted On ==

[[Machine/justice|Freedom]] using docker

All the stuff lives in ''/srv/znc''

=== Ports ===

6667

== Setup ==

Run:

docker run -d -p 6667:6667 -v /srv/znc:/znc-data --name=ZNC-Platypus --cpuset="7" -c 1 -m 300m jimeh/znc

Pull:

docker pull jimeh/znc

Features/Fixing Collab (Tubes)

2015-12-24T08:02:54Z

SAMdroid: /* Scope */ Hide tubes disabling behind flag

= Fixing Collaboration (Tubes) =

== Summary ==

Collaboration (hereon called collab) is build upon a framework called telepathy. Many years ago, the Telepathy Tubes (one type of channel) was deprecated. They have now been removed from telepathy (Fedora 22+) and therefore sugar collab does not work on newer systems.

This feature is to migrate to a new method, as well as moving the boilerplate code that activities use to do collab into an abstraction for easy porting.

== Background ==

Sugar uses telepathy to do collab. Lets look a how telepathy works from my understanding:

* Accounts (eg. jabber server, salut local network link)
* Connections - when you connect to a buddy over an account
* Channels - using a connection, you can make a channel to send data to a buddy

Let's look at some of the types of channels:

* Text - you can send text. Used for IM applications, but realistically can be used to transfer any text data. Chat activity uses this
* FileTransfer - a buddy can offer to send another buddy a file, which can be backed by anything (eg. can be send from memory to memory)
* DBusTube - a shared dbus thing
* StreamTube - shared socket thing
* Tubes - DEPRECATED. Many sugar activities use this. It is like a whole connection due to the fact that you can negotiate other tubes over your Tubes channel. For design reasons, it got replaces by DBusTUbe and StreamTube channels.

== Scope ==

# Sugar toolkit negotiates channels for the activity. It gives them a text and tubes channel. This is where the error happens, and must be changed to only give the activity a text channel. However, since OLPC OS still supports tubes, this should be behind a flag. (namely, the gsetting org.sugarlabs.collaboration.tubes-supported). See https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/282 (and the required https://github.com/sugarlabs/sugar/pull/644)
# Activities that depend on tubes now don't work. Hypothetically, they could be ported to use DBusTube and StreamTube channels. However, that is very hard and generally a massive pain, given that most activities have about 150 lines of slightly varying boilerplate tube negotiation. This can be replaced with a high level abstraction, so that the activity only deals with what data to send, rather than how to send that data. See https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/272
# However, some activities need to send large blobs to single buddies (eg. a new buddy joins read, needs a copy of the file). This is not suited to a json encoded message. However, we can use FileTransfer tubes (see the patch above). However, the shell currently claims all file transfers, so we need to have a special identifier for the shell to know to disregard these, see https://github.com/sugarlabs/sugar/pull/621
# All activities (other than Chat) need to be ported to the collab wrapper
# To maintain backwards compatability for activities, they can use a polyfill version of the CollabWrapper, see https://github.com/walterbender/physics/pull/10

= Benefit to Sugar =

For users, they get working collab on newer platforms.

For developers, they get a high level api that makes it easy to add collab to their activities. They no longer need to add 150 lines of confusing tube negotiation boilerplate or reinvent a message passing system.

= UI Design =

N/A

= How to test =

Run activities. Share them between computers with the patch, and old (fedora 18) XOs. See them working together.

This is TODO.

= Dependencies =

None

= Contingency Plan =

Collab will be broken again.

= Release Notes =

Sugar now sports a brand new collaboration engine that makes collaboration work in new and exciting places. Developers can now use the new CollabWrapper API to enable collaboration in their activities with ease.

0.108/Feature List

2015-12-22T00:12:40Z

SAMdroid:

<noinclude>[[Category:FeatureList]]</noinclude>
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Owner !! Complete !! Name !! Summary !! Feature Page !! PRs !!Updated
|-
| Sam || || Replace GtkMenu || Replace the use of GtkMenu in palettes in the Sugar code || [[Features/Replace GtkMenu]] || ||
|-
| Tch || 100% || Trigger Bundle Add || Let external scripts explicitly tell the registry to add a bundle || [[Features/Trigger Bundle Add]] || [https://github.com/sugarlabs/sugar/pull/584 584] ||
|-
| Gonzalo || 100% || Publish Sugar Version || Publish an env variable to allow activities to know what Sugar version is running || [[Features/Publish Sugar Version]] || ||
|-
| Tch || 100% || Fix bundle install issues || Activity bundle directories are now touched as a signal for installation by the BundleRegistry || [[Features/Trigger Bundle Add]] || [https://github.com/sugarlabs/sugar/pull/584 584] || 31 Oct
|-
| Sam || 5% || 'Fix' collaboration || Migrate collaboration to telepathy text channels, add abstractions, port activities || None || [[Features/Fixing_Collab_(Tubes)]] || 31 Oct
|-
| Ignacio Code by: Ezequiel Pereira (GCI 2015) || 100% || Change home view name || Improve existing [[Features/Multiple_home_views|multiple home views]] feature to allow customisation of home view name || [[Features/Change home view name]] || [https://github.com/sugarlabs/sugar/pull/623 623] [https://github.com/sugarlabs/sugar/pull/624 624] || 21 Dec Merged
|-
|}

Release noteworthy things:

* https://github.com/sugarlabs/sugar/pull/580 - When you remove the battery, Sugar does too! The battery icon is shown/hidden from the Frame when you remove/replace the battery.
* https://bugs.sugarlabs.org/ticket/3672#comment:2 - View source now gives you feedback when you duplicate an activity.
* https://github.com/sugarlabs/sugar/pull/592 - Sugar will now power off even if some activities are unresponsive.
* https://github.com/sugarlabs/sugar/pull/606 - Pressing <alt><shift>M will now launch My Settings
* https://github.com/sugarlabs/sugar/pull/608 - sugar-install-bundle now accepts multiple bundles - eg. ''sugar-install-bundle my-activity.xo your-activity.xo Downloads/*''
* https://github.com/sugarlabs/sugar/pull/637 - Things in the neighbourhood view are now placed in a consistent way.

0.108/Feature List

2015-12-22T00:01:17Z

SAMdroid: Add link to fixing collab feature page

Features/Fixing Collab (Tubes)

2015-12-22T00:00:02Z

SAMdroid: Created page with "= Fixing Collaboration (Tubes) = == Summary == Collaboration (hereon called collab) is build upon a framework called telepathy. Many years ago, the Telepathy Tubes (one type..."

= Fixing Collaboration (Tubes) =

== Summary ==

Collaboration (hereon called collab) is build upon a framework called telepathy. Many years ago, the Telepathy Tubes (one type of channel) was deprecated. They have now been removed from telepathy (Fedora 22+) and therefore sugar collab does not work on newer systems.

This feature is to migrate to a new method, as well as moving the boilerplate code that activities use to do collab into an abstraction for easy porting.

== Background ==

Sugar uses telepathy to do collab. Lets look a how telepathy works from my understanding:

* Accounts (eg. jabber server, salut local network link)
* Connections - when you connect to a buddy over an account
* Channels - using a connection, you can make a channel to send data to a buddy

Let's look at some of the types of channels:

* Text - you can send text. Used for IM applications, but realistically can be used to transfer any text data. Chat activity uses this
* FileTransfer - a buddy can offer to send another buddy a file, which can be backed by anything (eg. can be send from memory to memory)
* DBusTube - a shared dbus thing
* StreamTube - shared socket thing
* Tubes - DEPRECATED. Many sugar activities use this. It is like a whole connection due to the fact that you can negotiate other tubes over your Tubes channel. For design reasons, it got replaces by DBusTUbe and StreamTube channels.

== Scope ==

# Sugar toolkit negotiates channels for the activity. It gives them a text and tubes channel. This is where the error happens, and must be changed to only give the activity a text channel. See https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/270
# Activities that depend on tubes now don't work. Hypothetically, they could be ported to use DBusTube and StreamTube channels. However, that is very hard and generally a massive pain, given that most activities have about 150 lines of slightly varying boilerplate tube negotiation. This can be replaced with a high level abstraction, so that the activity only deals with what data to send, rather than how to send that data. See https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/272
# However, some activities need to send large blobs to single buddies (eg. a new buddy joins read, needs a copy of the file). This is not suited to a json encoded message. However, we can use FileTransfer tubes (see the patch above). However, the shell currently claims all file transfers, so we need to have a special identifier for the shell to know to disregard these, see https://github.com/sugarlabs/sugar/pull/621
# All activities (other than Chat) need to be ported to the collab wrapper
# To maintain backwards compatability for activities, they can use a polyfill version of the CollabWrapper, see https://github.com/walterbender/physics/pull/10

= Benefit to Sugar =

For users, they get working collab on newer platforms.

For developers, they get a high level api that makes it easy to add collab to their activities. They no longer need to add 150 lines of confusing tube negotiation boilerplate or reinvent a message passing system.

= UI Design =

N/A

= How to test =

Run activities. Share them between computers with the patch, and old (fedora 18) XOs. See them working together.

This is TODO.

= Dependencies =

None

= Contingency Plan =

Collab will be broken again.

= Release Notes =

Sugar now sports a brand new collaboration engine that makes collaboration work in new and exciting places. Developers can now use the new CollabWrapper API to enable collaboration in their activities with ease.

Oversight Board/2015-2016-candidates

2015-11-30T21:02:08Z

SAMdroid: /* Candidates */ I believe that the nominations are still open, so I will nominate myself

<noinclude>[[Category:Oversight board]]
[[Category:Governance]]
[[Category:Team]]
</noinclude>

==Election==
All seven (7) seats are open for election / re-election to the [[Oversight Board|Sugar Labs Oversight Board]] for 2015-2016.

==Candidates==
Here are the candidates (copied over from last year)
* Gonzalo Odiard ([[User:Godiard/SugarOversightCandidacy2012#Sugar_Oversight_candidacy_2015.2F2016|proposals]])
* Edward [[User:Mokurai | Mokurai]] Cherlin [[Open Educational Resources]]
* Claudia Urrea (http://wiki.sugarlabs.org/go/User:Claudia_Urrea)
* Laura Vargas [http://pe.sugarlabs.org/ir/~kaametza Sugar Evolution]
* Adam Holt ([[User:Holt|platform]])
* Walter Bender ([[User:Walter|Sugar Stable/Sugar Future]])
* Sam Parkinson ([[User:SAMdroid#Platform_2015]])
* '''Your name''' (''link to your platform'')

==References==
* [[Oversight_Board/2014-2015-candidates]]
* [[Oversight_Board/2013-2014-candidates]]
* [[Oversight_Board/2012-2013-candidates]]
* [[Oversight_Board/2011-2012-candidates]]
* [[Oversight_Board/2010-2011-candidates]]
* [[Oversight_Board/2009-2010-candidates]]
* [[Sugar Labs/Members]]

User:SAMdroid

2015-11-30T20:58:43Z

SAMdroid: /* Platform 2015 */

Hi,

I'm Sam. You are probably looking for my githubː https://www.github.com/samdroid-apps

Contact be via email via sam AT sam DOT today

== Platform 2015 ==

TL;DRː Human, coherent design let's Sugar users do things better - we must keep this as an advantage. Leveraging our openness as a community and getting people talking will make Sugar into a platform that people love. Sugar must introduce new people and get there perspectives to grow.

Visionary Designː Sugar is a platform with emphasis on coherent design. Sugar's design flows through the whole system - with the Journal as an intergrated hub for documents, the Neigbourhood view as an intergrated hub for interacting with the people around me. I think that Sugar's intergrated design provides an advantage for users - we have one clean and simple way of doing things. I believe that our goal should be to further realise our design so that we have a system that users love. I've worked on internal things (eg. recently working on fixing the collab stack) that help realise these designs.

Talking to Peopleː I believe that the success of Sugar as a free software project relies upon us taking advantage of the fundamental benefit of free software - the openness within the community. Sugar will see success as we reach out to users, as we engage every teacher and distributor. Through platforms like social help, we're begining to see more people open a conversation about sugar, which can only lead to us being able to improve Sugar in response. I've also recently conducted a survey which has also showed fundamental things that can be tweaked to improve Sugar.

Growthː Sugar is a coherent yet powerful (runs traditional Linux apps too) platform, holding advantages over limited platforms like ChromeOS or Android. Through a less intimidating setup process (eg. easy Sugar stick creator), Sugar can attract new users. When new users engage with the community, they bring new perspectives and let us critically evaluate what we've made. When we work with "outsiders", we make something even better.

Oversight Board/2015-2016-candidates

2015-11-29T07:44:43Z

SAMdroid: Reverted edits by Godiard (talk) to last revision by Walter

<noinclude>[[Category:Oversight board]]
[[Category:Governance]]
[[Category:Team]]
</noinclude>

==Election==
All seven (7) seats are open for election / re-election to the [[Oversight Board|Sugar Labs Oversight Board]] for 2015-2016.

==Candidates==
Here are the candidates (copied over from last year)
* Gonzalo Odiard ([[User:Godiard/SugarOversightCandidacy2012#Sugar_Oversight_candidacy_2015.2F2016|proposals]])
* Edward [[User:Mokurai | Mokurai]] Cherlin [[Open Educational Resources]]
* Claudia Urrea (http://wiki.sugarlabs.org/go/User:Claudia_Urrea)
* Laura Vargas [http://pe.sugarlabs.org/ir/~kaametza Sugar Evolution]
* Adam Holt ([[User:Holt|platform]])
* Walter Bender ([[User:Walter|Sugar Stable/Sugar Future]])
* '''Your name''' (''link to your platform'')

==References==
* [[Oversight_Board/2014-2015-candidates]]
* [[Oversight_Board/2013-2014-candidates]]
* [[Oversight_Board/2012-2013-candidates]]
* [[Oversight_Board/2011-2012-candidates]]
* [[Oversight_Board/2010-2011-candidates]]
* [[Oversight_Board/2009-2010-candidates]]
* [[Sugar Labs/Members]]

User:SAMdroid

2015-11-29T02:32:24Z

SAMdroid: Maybe I'll run for SLOBs, but I'll just write something horrible now for me to proofread later

Hi,

I'm Sam. You are probably looking for my githubː https://www.github.com/samdroid-apps

Contact be via email via sam AT sam DOT today

== Platform 2015 ==

Should I do it?

More importantly, how do I spellcheck this?

TL;DRː Human, coherent design let's Sugar users do things better - we must keep this as an advantage. Leveraging our openness as a community and getting people talking will make Sugar into a platform that people love. Sugar must introduce new people and get there perspectives to grow.

Visionary Designː Sugar is a platform with emphasis on coherent design. Sugar's design flows through the whole system - with the Journal as an intergrated hub for documents, the Neigbourhood view as an intergrated hub for interacting with the people around me. I think that Sugar's intergrated design provides an advantage for users - we have one clean and simple way of doing things. I believe that our goal should be to further realise our design so that we have a system that users love. I've worked on internal things (eg. recently working on fixing the collab stack) that help realise these designs.

Talking to Peopleː I believe that the success of Sugar as a free software project relies upon us taking advantage of the fundamental benefit of free software - the openness within the community. Sugar will see success as we reach out to users, as we engage every teacher and distributor. Through platforms like social help, we're begining to see more people open a conversation about sugar, which can only lead to us being able to improve Sugar in response. I've also recently conducted a survey which has also showed fundamental things that can be tweaked to improve Sugar.

Growthː Sugar is a coherent yet powerful (runs traditional Linux apps too) platform, holding advantages over limited platforms like ChromeOS or Android. Through a less intimidating setup process (eg. easy Sugar stick creator), Sugar can attract new users. When new users engage with the community, they bring new perspectives and let us critically evaluate what we've made. When we work with "outsiders", we make something even better.

Features/Sugar3 Docs/How To Write

2015-11-17T08:14:32Z

SAMdroid: Add a note about adding the doc label

This will guide your through how to write docs for a module in sugar3. There are 5 easy steps to writing the documentation, and 3 bonus steps for getting it merged.

Example patch: https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/269/files or https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/256/files

= How To Guide =

1. Write a code example for using the code. Try to write a stand alone python script that demonstrates the major features of the module and put in the ''examples'' directory in sugar-toolkit-gtk3. If it can not be demonstrated standalone, write a code sample that the user could paste into their activity, simmilar to the ''sugar3.graphics.alert'' example. When writing the example, add comments to explain what code is doing that might be non obvious (eg. that something is zero indexed, or that this function needs to be called first)

2. Write a blurb (a small paragraph, around 3 lines) for the module and include your example. Your blurb should say what this does and where to use it. Place this between the license and the imports. Including the example will always use the syntax ''.. literalinclude:: ../examples/SOMETHING.py''. For example:

<pre>'''
The combobox module provides a combo box; a button like widget which
creates a list popup when clicked. It's best used outside of a
toolbar when the user needs to choose from a *short* list of items.

Example:

.. literalinclude:: ../examples/combobox.py
'''</pre>

3. Document each class. Write a blurb about what the class does and where to use it. If the constructor takes any parameters, or if the class has any signals, they need to be documented here. Place this directly after the class definition. For example:

<pre>class PaletteMenuItem(Gtk.EventBox):
'''
A palette menu item is a line of text, and optionally an icon, that the
user can activate.

The `activate` signal is usually emitted when the item is clicked. It has
no arguments. When a menu item is activated, the palette is also closed.

Args:
text_label (str): a text to display in the menu

icon_name (str): the name of a sugar icon to be displayed. Takse
precedence over file_name

text_maxlen (int): the desired maximum width of the label, in
characters. By default set to 60 chars

xo_color (:class:`sugar.graphics.XoColor`): the color to be applied to
the icon

file_name (str): the path to a svg file used as icon

accelerator (str): a text used to display the keyboard shortcut
associated to the menu
'''</pre>

4. Document the class methods and global functions. You should document what the method/function does and any side effects that it has. If it takes arguments, the they must have their types and function documented. Same goes for return value. This should be placed after the definition. For example (the following are 2 separate methods from different classes):

<pre> def set_image(self, icon):
'''
Sets the icon widget. Usually this will be a
:class:`sugar3.graphics.icon.Icon`.

Args:
icon (:class:`Gtk.Widget`): icon widget
'''
self._hbox.pack_start(icon, expand=False, fill=False,
padding=style.DEFAULT_PADDING)
self._hbox.reorder_child(icon, 0)</pre>
<pre> def get_value(self):
'''
The value of the currently selected item; the same as the `value`
argument that was passed to the `append_item` func.

Returns:
object, value of selected item
'''
row = self.get_active_item()
if not row:
return None
return row[0]</pre>

5. '''Proofread'''. Use the 'make_docs.sh' to build the docs. Then ''cd doc/_build/html'' and start a http server (''python -m SimpleHTTPServer 8000''). Load 'localhost:8000'' in your favorite web browser and check that your documentation has rendered correctly and makes sense. Make sure you have a spell checker in your text editor (the vim one in very nice as it only checks strings and docstrings), because I can't spell or check.

[[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) I'm being hypocritical saying this, but I'll proof it soon :)

6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.

7. Create a pull request on GitHub, and make sure to add the ''doc'' label while you are making it.

8. Listen to whoever reviews your patch.

= Syntax Information =

The docgen uses sphinx. Sphinx uses reStructuredText as a markup. We then use autodoc and napoleon to write docstrings using google style.

Napolean quick intro: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/

reStructuredText primer: http://sphinx-doc.org/rest.html

how do I go X in sphinx?: I'm too lazy to find docs. Just duckduckgo or google "sphinx X" if you haven't already.

Features/Sugar3 Docs/How To Write

2015-11-17T07:10:57Z

SAMdroid: /* Syntax Information */ Fix formatting of newlines

This will guide your through how to write docs for a module in sugar3. There are 5 easy steps to writing the documentation, and 2 bonus steps for getting it merged.

Example patch: https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/269/files or https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/256/files

= How To Guide =

1. Write a code example for using the code. Try to write a stand alone python script that demonstrates the major features of the module and put in the ''examples'' directory in sugar-toolkit-gtk3. If it can not be demonstrated standalone, write a code sample that the user could paste into their activity, simmilar to the ''sugar3.graphics.alert'' example. When writing the example, add comments to explain what code is doing that might be non obvious (eg. that something is zero indexed, or that this function needs to be called first)

2. Write a blurb (a small paragraph, around 3 lines) for the module and include your example. Your blurb should say what this does and where to use it. Place this between the license and the imports. Including the example will always use the syntax ''.. literalinclude:: ../examples/SOMETHING.py''. For example:

<pre>'''
The combobox module provides a combo box; a button like widget which
creates a list popup when clicked. It's best used outside of a
toolbar when the user needs to choose from a *short* list of items.

Example:

.. literalinclude:: ../examples/combobox.py
'''</pre>

3. Document each class. Write a blurb about what the class does and where to use it. If the constructor takes any parameters, or if the class has any signals, they need to be documented here. Place this directly after the class definition. For example:

<pre>class PaletteMenuItem(Gtk.EventBox):
'''
A palette menu item is a line of text, and optionally an icon, that the
user can activate.

The `activate` signal is usually emitted when the item is clicked. It has
no arguments. When a menu item is activated, the palette is also closed.

Args:
text_label (str): a text to display in the menu

icon_name (str): the name of a sugar icon to be displayed. Takse
precedence over file_name

text_maxlen (int): the desired maximum width of the label, in
characters. By default set to 60 chars

xo_color (:class:`sugar.graphics.XoColor`): the color to be applied to
the icon

file_name (str): the path to a svg file used as icon

accelerator (str): a text used to display the keyboard shortcut
associated to the menu
'''</pre>

4. Document the class methods and global functions. You should document what the method/function does and any side effects that it has. If it takes arguments, the they must have their types and function documented. Same goes for return value. This should be placed after the definition. For example (the following are 2 separate methods from different classes):

<pre> def set_image(self, icon):
'''
Sets the icon widget. Usually this will be a
:class:`sugar3.graphics.icon.Icon`.

Args:
icon (:class:`Gtk.Widget`): icon widget
'''
self._hbox.pack_start(icon, expand=False, fill=False,
padding=style.DEFAULT_PADDING)
self._hbox.reorder_child(icon, 0)</pre>
<pre> def get_value(self):
'''
The value of the currently selected item; the same as the `value`
argument that was passed to the `append_item` func.

Returns:
object, value of selected item
'''
row = self.get_active_item()
if not row:
return None
return row[0]</pre>

5. '''Proofread'''. Use the 'make_docs.sh' to build the docs. Then ''cd doc/_build/html'' and start a http server (''python -m SimpleHTTPServer 8000''). Load 'localhost:8000'' in your favorite web browser and check that your documentation has rendered correctly and makes sense. Make sure you have a spell checker in your text editor (the vim one in very nice as it only checks strings and docstrings), because I can't spell or check.

[[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) I'm being hypocritical saying this, but I'll proof it soon :)

6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.

7. Listen to whoever reviews your patch.

= Syntax Information =

The docgen uses sphinx. Sphinx uses reStructuredText as a markup. We then use autodoc and napoleon to write docstrings using google style.

Napolean quick intro: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/

reStructuredText primer: http://sphinx-doc.org/rest.html

how do I go X in sphinx?: I'm too lazy to find docs. Just duckduckgo or google "sphinx X" if you haven't already.

Features/Sugar3 Docs/How To Write

2015-11-17T07:09:12Z

SAMdroid: Write the first version this page.

This will guide your through how to write docs for a module in sugar3. There are 5 easy steps to writing the documentation, and 2 bonus steps for getting it merged.

Example patch: https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/269/files or https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/256/files

= How To Guide =

1. Write a code example for using the code. Try to write a stand alone python script that demonstrates the major features of the module and put in the ''examples'' directory in sugar-toolkit-gtk3. If it can not be demonstrated standalone, write a code sample that the user could paste into their activity, simmilar to the ''sugar3.graphics.alert'' example. When writing the example, add comments to explain what code is doing that might be non obvious (eg. that something is zero indexed, or that this function needs to be called first)

2. Write a blurb (a small paragraph, around 3 lines) for the module and include your example. Your blurb should say what this does and where to use it. Place this between the license and the imports. Including the example will always use the syntax ''.. literalinclude:: ../examples/SOMETHING.py''. For example:

<pre>'''
The combobox module provides a combo box; a button like widget which
creates a list popup when clicked. It's best used outside of a
toolbar when the user needs to choose from a *short* list of items.

Example:

.. literalinclude:: ../examples/combobox.py
'''</pre>

3. Document each class. Write a blurb about what the class does and where to use it. If the constructor takes any parameters, or if the class has any signals, they need to be documented here. Place this directly after the class definition. For example:

<pre>class PaletteMenuItem(Gtk.EventBox):
'''
A palette menu item is a line of text, and optionally an icon, that the
user can activate.

The `activate` signal is usually emitted when the item is clicked. It has
no arguments. When a menu item is activated, the palette is also closed.

Args:
text_label (str): a text to display in the menu

icon_name (str): the name of a sugar icon to be displayed. Takse
precedence over file_name

text_maxlen (int): the desired maximum width of the label, in
characters. By default set to 60 chars

xo_color (:class:`sugar.graphics.XoColor`): the color to be applied to
the icon

file_name (str): the path to a svg file used as icon

accelerator (str): a text used to display the keyboard shortcut
associated to the menu
'''</pre>

4. Document the class methods and global functions. You should document what the method/function does and any side effects that it has. If it takes arguments, the they must have their types and function documented. Same goes for return value. This should be placed after the definition. For example (the following are 2 separate methods from different classes):

<pre> def set_image(self, icon):
'''
Sets the icon widget. Usually this will be a
:class:`sugar3.graphics.icon.Icon`.

Args:
icon (:class:`Gtk.Widget`): icon widget
'''
self._hbox.pack_start(icon, expand=False, fill=False,
padding=style.DEFAULT_PADDING)
self._hbox.reorder_child(icon, 0)</pre>
<pre> def get_value(self):
'''
The value of the currently selected item; the same as the `value`
argument that was passed to the `append_item` func.

Returns:
object, value of selected item
'''
row = self.get_active_item()
if not row:
return None
return row[0]</pre>

5. '''Proofread'''. Use the 'make_docs.sh' to build the docs. Then ''cd doc/_build/html'' and start a http server (''python -m SimpleHTTPServer 8000''). Load 'localhost:8000'' in your favorite web browser and check that your documentation has rendered correctly and makes sense. Make sure you have a spell checker in your text editor (the vim one in very nice as it only checks strings and docstrings), because I can't spell or check.

| [[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) I'm being hypocritical saying this, but I'll proof it soon :)

6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.

7. Listen to whoever reviews your patch.

= Syntax Information =

The docgen uses sphinx. Sphinx uses reStructuredText as a markup. We then use autodoc and napoleon to write docstrings using google style.

Napolean quick intro: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/
reStructuredText primer: http://sphinx-doc.org/rest.html
how do I go X in sphinx?: I'm too lazy to find docs. Just duckduckgo or google "sphinx X" if you haven't already.

Google Code In 2015

2015-11-13T21:06:50Z

SAMdroid: /* Documentation/Training */ less than a day doesn't give the maintainer enough time to sleep

<noinclude>[[Category:Trac Reference]][[Category:Idea]]
[[Category: GCI2015]]</noinclude>
This is the project page for the Sugar Labs application to [http://www.google-melange.com/gci/homepage/google/gci2015 Google Code In 2015]. Sugar Labs community members: please feel free to add tasks below. We'll do an edit before final applications are due the first week of November 2015.

== Message to potential participants ==

It is important that you obtain permission of your parents.

Es importante que obtengas el permiso de tus padres para participar.

https://developers.google.com/open-source/gci/resources/contest-rules

Please see the Contest Rules for Eligibility and Registration process.

https://developers.google.com/open-source/gci/resources/contest-rules

'''Details regarding the required forms and paperwork are here: [[Google Code In 2015/Participate#Students]].'''

Also, you will likely need to set up the Sugar development environment. See http://developer.sugarlabs.org/dev-environment.md.html for details. Further information about contributing to the project can be found here: http://developer.sugarlabs.org/

Please don't hesitate to ask questions on our irc channel (#sugar on irc.freenode.net) or on the sugar-devel list: sugar-devel AT lists.sugarlabs DOT org

== Why we are participating ==

Sugar is written and maintained by volunteers, who range from seasoned professionals to children as young as 12-years of age. Children who have grown up with Sugar have transitioned from Sugar users to Sugar App developers to Sugar maintainers. They hang out on IRC with the global Sugar developer community and are full-fledged members of the Sugar development team. It is this latter group of children we hope will participate in and benefit from Google Code-in. Specifically we want to re-enforce the message that Sugar belongs to its users and that they have both ownership and the responsibility that ownership implies. Just as learning is not something done to you, but something you do, learning with Sugar ultimately means participating in the Sugar development process. At Sugar Labs, we are trying to bring the culture of Free Software into the culture of school. So the Code-in is not just an opportunity for us to get some tasks accomplished, it is quintessential to our overall mission.

== Some background from GCI ==

[See https://developers.google.com/open-source/gci/resources/getting-started]

===Open Source Fundamentals ===

You can contribute without being a coder!
You do not have to be a coder to contribute to open source. There are many different skill sets needed to help an open source community thrive:
;Documentation: If you are a good writer and enjoy attention to detail then you might want to contribute by writing or editing documentation. Documentation is a huge part of a successful open source project. Organizations need documentation to help attract new contributors as it helps them see what the codebase looks like and where things are and what the plan is for the project.
;Research: An organization may need help crunching numbers or sorting through pages of documents to better understand what the users want or need. There are many different types of tasks that students could work on that are very important to the health of the project.
;Outreach: If you have an outgoing personality and like being around and talking to people, take a look at the outreach tasks. Outreach tasks often include hosting meetups in your local community or creating a plan on how people around the globe can host a meetup about the project in their local communities.
;Training: You could create a YouTube video discussing a new feature of the project or maybe some basics on what the project does so people who haven’t heard about it can understand the project and get involved.
;User Interface: User interface can include many types of tasks including designing new aspects of a webpage or creating a new logo for the project. It may also include various accessibility opportunities to help make the project easier for people who are blind.
;Other: If you have an idea that may help an organization, reach out to them and let them know! Sometimes the best task is one that the organization hasn’t even considered yet.
=== Collaboration===
Open source is not just about coding but working with other people to find the best solution. Being a part of the community is an essential part of success in Google Code-in. Mentors tell us every year that their best students were the ones who worked hard on their projects but also participated on IRC and helped answer questions other students had.

=== Quality over Quantity ===

It’s not about being the student who completes the most tasks, that only gets you to the top 10 to be reviewed, it doesn’t mean you will be a grand prize winner. We have had quite a few students who completed the most tasks for their organization yet were not named as Grand Prize Winners because they did everything solo and didn’t get involved in the community or think about the health of the project as a whole, they just kept completing task after task like a machine. If you actively participate in the community then you not only feel the camaraderie that comes with working as a team but you become committed to making the project better for everyone.

== Some basics about Sugar Labs ==

For some basics about the project, see [http://people.sugarlabs.org/walter/docs/Learning-to-Change-the-World-Chapter-4.pdf Chapter 4 of Learning to Change the World].

=== Getting started with coding ===

Sugar development is in either Python or Javascript.

* You will need knowledge of Python and GTK (See http://python-gtk-3-tutorial.readthedocs.org/en/latest/);
* or Javascript/HTML5;
* and then the basic of Sugar development (See http://www.flossmanuals.net/make-your-own-sugar-activities/);
* and to have a Sugar development environment running (See http://developer.sugarlabs.org).

Please note that you must run [http://legacy.python.org/dev/peps/pep-0008/#introduction pep8] and pyflakes on your code ''before'' submitting your patches.

=== Getting started with GIT ===

Some knowledge of git is important as your work will be submitted to our git repository (https://github.com/sugarlabs). The basic mechanism is a pull request (PR), which is detailed in [http://developer.sugarlabs.org/contributing.md.html].

GitHub provides a tutorial (See https://try.github.io/levels/1/challenges/1), although there are many others as well.

Note that our bug tracker is http:bugs.sugarlabs.org.

=== Getting started with Sugarizer ===

Sugar Web Framework is the JavaScript Framework for Sugar [https://github.com/sugarlabs/sugar-docs/blob/master/web-architecture.md]. Sugarizer [http://sugarizer.org] is a subset of Sugar that allow runing activities developed with Sugar Web Framework on any web browser. Sugarizer is also available as Android, iOS, Firefox OS and Chrome Web App.

== Tasks ==
'''Note:''' This is our preliminary list of tasks. We can add more as the contest progresses.

Mentors: please feel free to add more tasks and/or add yourself as a potential mentor to an existing task.

Tasks must fall within one of these five categories: [[#Documentation/Training]]; [[#Outreach/Research]]; [[#User Interface]]; [[#Quality Assurance]]; and [[#Code]].

===Beginner Tasks===
We have several tasks that are targeting people new to Sugar and Sugar development. You are only allowed to complete two beginner tasks.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Title !! Description !! Hours !! Mentor !! Tag
|-
|Install the Sugar development environment||Following the instruction at [http://developer.sugarlabs.org/dev-environment.md.html], set up the Sugar development environment. Submit a screen-shot of the development environment running to complete this task. You can get help on our irc channel should you run into any difficulties.|| 48 || all || beginner
|-
|Install Sugar in a virtual machine||If your intention is to focus on documentation and training or outreach, then you may want to install Sugar in a virtual machine. Following the instructions at [http://wiki.sugarlabs.org/go/Sugar_Creation_Kit#Tutorials][http://wiki.sugarlabs.org/go/Sugar_on_a_Stick/Virtual_machines][http://wiki.sugarlabs.org/go/Downloads#Virtual_Machines_on_all_platforms], set up the Sugar development environment. Submit a screen-shot of the development environment running to complete this task. You can get help on our irc channel should you run into any difficulties.|| 48 || all || beginner
|-
|Create an example program in Turtle Blocks||We distribute examples with the Turtle Blocks programming environment. Create your example -- some art, some geometry, some multimedia, a simple game -- to be included with the package. Deliverable is a Turtle Blocks project file to be reviewed by Sugar Labs designers and educators. (Use either the Python version bundled with Sugar or the Javascript version at [http://turtle.sugarlabs.org Turtle Blocks JS]) One source of inspiration might be [https://www.pinterest.com/walterbender/turtle-art/]. || 48 || all || beginner
|-
|Create an example program in Music Blocks||We distribute examples with the [http://walterbender.github.io/musicblocks Music Blocks] programming environment. Create your example -- some music (and art) -- to be included with the package. Deliverable is a Music Blocks project file to be reviewed by Sugar Labs designers and educators. || 48 || all || beginner
|-
|Create a simple machine in Physics||We distribute examples with the [http://activities.sugarlabs.org/en-US/sugar/addon/4193 Physics Activity]. Create a simple machine we can include in the examples collection -- some interesting mechanical device. Deliverable is a Physics activity project file to be reviewed by Sugar Labs designers and educators. || 48 || all || beginner
|}

===Documentation/Training===
Tasks related to creating/editing documents and helping others learn more

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Title !! Description !! Hours !! Mentor !! Tag
|-
|Update the Sugar Labs entry in Wikipedia|| The Sugar Labs entry in Wikipedia could use some TLC. Please bring it up to date. || 48 || Walter || Documentation
|-
|Update the Sugar Labs wiki page on git||The [[Activity Team/Git Tutorial]] is out of date: we have migrated to GitHub. Please update the page to reflect the GitHub workflow. See http://developer.sugarlabs.org/contributing.md.html for more details || 48 || Walter || Documentation
|-
|Turtle Blocks Programming Guide 1|| Add live examples missing from the [https://github.com/walterbender/turtleblocksjs/blob/master/guide/README.md Guide to Programming with Turtle Blocks]. || 48 || Walter || Documentation
|-
|Turtle Blocks Programming Guide 2|| Extend the [https://github.com/walterbender/turtleblocksjs/blob/master/guide/README.md Guide to Programming with Turtle Blocks] to include more examples. || 48 || Walter || Documentation
|-
|Music Blocks Programming Guide|| Extend the [https://github.com/walterbender/musicblocks/blob/master/guide/README.md Guide to Programming with Music Blocks] to include more examples. || 48 || Walter || Documentation
|-
|Turtle Blocks Classroom Guide||Write a guide on how to use Turtle Blocks in the classroom -- a manual for teachers who might want to engage in programming. Please consult with a classroom teacher when creating the guide.|| 96 || Walter || Documentation
|-
|Music Blocks Classroom Guide||Write a guide on how to use Music Blocks in the classroom -- a manual for teachers who might want to engage in programming with Music. Please consult with a music teacher when creating the guide.|| 96 || Walter || Documentation
|-
|Sugarizer Server API Documentation||Write a documentation for the REST API for Sugarizer Server. Include some GET/POST/DELETE sample inside || 48|| Lionel || Documentation
|-
|Sugarizer Server Collaboration Tutorial||Write a tutorial on how to connect a Sugarizer Client to a Sugarizer Server and how to use it to do Journal sharing and collaboration || 24 || Lionel || Documentation
|-
|Sugarizer wiki page||Write a Sugarizer page in the SugarLabs wiki || 24 || Lionel || Documentation
|}

For information about how to create help pages for activities

http://wiki.sugarlabs.org/go/Activities/Help/Contribute

https://github.com/godiard/help-activity/blob/master/source/restructuredtext.rst

https://github.com/godiard/help-activity/blob/master/source/collaborating.rst

===Outreach/Research===
Tasks related to community management, outreach/marketing, or studying problems and recommending solutions

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Title !! Description !! Hours !! Mentor !! Tag
|-
|Turtle Art Day||Organize a Turtle Art Day in your community. Details at [http://people.sugarlabs.org/walter/Guia_Ingles_10-08-2013.pdf]||96||Walter||Outreach
|-
|Promo Video||Create a 60 second promotional video on Sugar and its community.||96||Mariah||Outreach
|-
|Hangout Q&A||Host a Question and Answer (Q&A)/Information session about Sugar on Google Hangouts. Invite friends, family, peers, as well as academic and community leaders.||96||Mariah||Outreach
|-
|Local Lab Wiki||Create/update a "Local Lab" page for your area/country. Fill in the page with information on the Sugar community in your area. This could include contact information, mailing lists, events and any other information that may be relevant. ||96||Mariah||Research
|-
|How-To Guide||Create a guide for how to host your own DIY Sugar on a Stick party. The guide should include at least two promotional item designs (like a sticker, brochure, flyer). Feel free to change the name to something else. ||96||Mariah||Outreach
|-
|DIY Sugar on a Stick||Organize and host a Sugar on a Stick party where you show people how to make their own Sugar on a Stick. Then, hold a workshop on the basics of using Sugar. Take pictures to document the experience. Post a blog about it.||96||Mariah||Outreach
|-
|Potential Users||Gather information on who could benefit from using or knowing about Sugar. Look at non-profit organizations, academic institutions, the home-school community. Build a database including contact information, website URLS, social media profiles, and any other relevant information.||96||Mariah||Research
|-
|Sugar Tools & Resources||Find the resources that people are using throughout the world to learn about or teach Sugar Activities. This can include manuals, teacher guides, YouTube videos, blogs, etc. Document what type of resource it is, the URL for the resource, the target audience of the resource and whether it is up-to-date.||96||Mariah||Research
|-
|Introduce Yourself||Write a blog post about why you are participating in Google Code-In, what you hope to learn from the GCI and how Sugar Labs can help you. Include a picture. Share blog post through social media.||48||Mariah||Outreach
|-
|Interview a GCI Peer||Interview another Sugar Labs GCI participant. Ask them questions about how they are selecting/completing tasks, any successes/struggles they are having, etc. Post on participant blog. Share blog post through social media.||48||Mariah||Outreach
|--
|Interview an Educator||Find an educator who is using open-source educational software to teach. Interview the educator about their experience as an educator and why they are using open-source software to teach. Post about it on the blog, include a picture. Share the blog post through social media and with the educator.||48||Mariah||Outreach|
|-
|Review an Activity||Write a review about an Activity in Sugar. Explain how you use it, what kind of project you could do with it, any bugs it might have, etc. Post your review. The review can be a video review or a written review with screenshots. Share the blog post through social media.||48||Mariah||Outreach
|-
|Women in the Sugar Community||Create a 10-minute presentation celebrating at least three women within the Sugar community and/or the open-source community at large. Write a blog post about what you learned when making this presentation and include a link to the presentation.||48||Mariah||Outreach
|-
|Wrap-Up||Write a blog post about your experience as a GCI participant for Sugar Labs. Share your thoughts on what was successful and what can be improved for next year's participants. Feel free to include pictures, videos, links to work that you are most proud of. Share the post through social media.||48||Mariah||Outreach
|-
|Analyze and optimize the Sugar Labs wiki performance.|| The main documentation for the Sugar Labs organization is placed in the Sugar Labs wiki. Speeding up the wiki access is important for the community. Analyze and optimize our wiki using Google PageSpeed Tools. Get a score of 85 or above for the Sugar Labs wiki. [https://developers.google.com/speed/ Google PageSpeed] || 144 || Bernie || Research, QA
|-
|New mailing list for Sugar Labs|| In Sugar Labs, as most open source organizations, we use mailing lists to communicate with one another. Currently, we are using mailman 2. Make some research, for example among other open source organizations, to propose at least one new open source package to deploy a new mailing list for Sugar Labs. Implement the chosen software using Docker containers. || 144 || Bernie || Research
|-
|High availability in our Docker infrastructure || In Sugar Labs, mainly we use Virtual Machines and Docker containers to host our main services. We want you to test the Docker Swarm functionality in order to create a Docker cluster. For this task, you will have two clean Ubuntu VMs in order to install and configure the Docker Swarm. We will provide you also two Docker images. In order to complete the task, the docker cluster and the failover functionality must be working. || 144 || Bernie || Research
|}

===User Interface===
Tasks related to user experience research or user interface design and interaction

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Title !! Description !! Hours !! Mentor !! Tag
|-
|Icon design for Music Blocks||The icons used for the main toolbar in Music Block don't "sing" to me. This task is to design better icons both in terms of expressing the intention of the button and visual engagement of the user. || 72 || Walter, Devin || UI, design
|-
|Save file design for Music Blocks||Since Music Blocks programs don't always create artwork, when you save the project, there may be no corresponding image to associate with it. This task is to design a default graphic to use in such cases. || 72 || Walter, Devin || UI, design
|-
|Classroom collaboration|| Sugar provides tools for sharing and collaborating among students, e.g., peer editing of texts, chat, group programming, etc. Survey the list of collaboration-enabled activities and categorize them by whether they are learning utilities, classroom management utilities, communication, games, etc. || 72 || Walter || UI, pedagogy
|-
|Classroom management 1|| Sugar provides only a few tools for classroom management, e.g., the Share With Teacher webservice. Survey classroom services that run either as web services or native in desktop environments.|| 72 || Walter || UI, pedagogy
|-
|Classroom management 2|| Sugar provides only a few tools for classroom management, e.g., the Share With Teacher webservice. Which of the results from the Classroom management 1 task would be useful to incorporate into the Sugar ecosystem? Evaluation should include s description of the service and a sketch of how the user interaction would work. || 72 || Walter || UI, pedagogy
|-
|Sugar on a small screen|| Sugar was originally designed as a desktop environment for small computers. But these days, many children have access to smart phones rather than computers. This task is to make some sketches as to how Sugar might be redesigned for a smart phone form-factor. A series of annotated sketches should be made as part of completing this task. || 72 || Walter || UI
|-
|Programming on a small screen|| We put an emphasis on programming in Sugar. One popular programming environment is Turtle Blocks. Recently we made a Javascript version that can run in a browser (and hence on a smart phone). How should the UI change to accommodate that form-factor? A series of annotated sketches should be made as part of completing this task. || 72 || Walter || UI
|-
|End-user customization||We try to encourage our users to re-imagine Sugar as they'd like it. Users can change the icon layout, the background screen, and the XO avatar. What else should be made easier to customize with minimal programming? || 72 || Walter || UI
|-
|Sugarizer marketing web page||Create a marketing web page to explain what is Sugarizer and replace the [http://sugarizer.org current one] || 40 || Lionel || UI
|}

===Quality Assurance===
Tasks related to testing and ensuring code is of high quality.

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Title !! Description !! Hours !! Mentor !! Tag
|-
|Behavior diff for Turtle Blocks JS|| [https://turtle.sugarlabs.org Turtle Blocks JS] is a Javascript port from the Python version of the activity. The goal of this task is to document any differences in behavior between the two versions.||72||Walter||QA
|-
|Unit tests for JS activities||We have no unit tests for our Javascript activities. This task is to investigate approaches to unit testing in Javascript||72||Walter||QA
|-
|Test Sugar on a Stick || Help test the latest Sugar on a Stick on Fedora (F21). See [http://dl.fedoraproject.org/pub/alt/stage/21_Beta_RC4/], [https://fedoraproject.org/wiki/Test_Results:Fedora_21_Beta_RC4_Desktop#Sugar_.28non-blocking.2C_all_arches.29] #fedora-qa (freenode IRC). Deliverable is a report of the major Sugar features, e.g., desktop, journal, collaboration, and the core activities, e.g., Write, Browse, Turtle, Chat, Speak, etc. || 48 || Satellit || QA, SoaS
|-
|Interview a teacher|| Ultimately the quality of our work is determined by our end users. Interview a classroom teacher who is using Sugar and solicit feedback about what works, what doesn't. || 72 || Walter || QA
|-
|Interview a student|| Ultimately the quality of our work is determined by our end users. Interview a student who is using Sugar in school and solicit feedback about what works, what doesn't. || 72 || Walter || QA
|}

===Code===
Tasks related to writing or refactoring code

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Title !! Description !! Hours !! Mentor !! Tag
|-
| Sugar Bug 3921 Journal palette is not updated|| [https://bugs.sugarlabs.org/ticket/3921 Ticket 3921] Journal palette is not updated when I stay in the same column || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 4172 Set color of insensitive buttons || [https://bugs.sugarlabs.org/ticket/4172 Ticket 4172] The greyed-out "Next" button on the intro screen comes up with the text in the same colour as the background, i.e. you cant see it. || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 4461 "Volume busy" dialog appear in Sugar || [https://bugs.sugarlabs.org/ticket/4461 Ticket 4461] Trying to unmount a pendrive, a "Volume is busy" dialog appear. || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 4613 Neighborhood view should respect max_participants limit || [https://bugs.sugarlabs.org/ticket/4613 Ticket 4613] max_participants should limit the number of joiners. If the maximum has been reached, joining should be disabled and some feedback given to the user. It would also be nice if the icon indicated (with a badge, perhaps) the maximum. || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 4894 Frame settings edge delay || [https://bugs.sugarlabs.org/ticket/4894 Ticket 4894] Frame settings doesn't allow option other that edge delay = 0 || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 381 Neighborhood view improvements || [https://bugs.sugarlabs.org/ticket/381 Ticket 381] Right now the neighborhood view is disappointingly random. Neighborhood view icons should be placed in a spatially repeatable way. || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 2478 Buttons unresponsive when launching Sugar || [https://bugs.sugarlabs.org/ticket/2478 Ticket 2478] Buttons unresponsive when launching Sugar until Journal appears on Home View || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 3006 Ad-hoc network icon mixup || [https://bugs.sugarlabs.org/ticket/3006 Ticket 3006] Ad-hoc network icons are not properly displayed at times|| 72 || Martin Abente || Code, Python
|-
| Sugar Bug 3119 Check if the connection has been established || [https://bugs.sugarlabs.org/ticket/3119 Ticket 3119] Check if the connection has been established || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 3143 Remove icon-slicer dependency || [https://bugs.sugarlabs.org/ticket/3143 Ticket 3143] icon-slicer is not needed. || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 3708 Sugar doesn't DHCP connecting to ad-hoc wifi point || [https://bugs.sugarlabs.org/ticket/3708 Ticket 3708] Add DHCP support for ad hoc networks || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 3831 Frame animation has regressed || [https://bugs.sugarlabs.org/ticket/3831 Ticket 3831] It is not smooth. || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 4449 Language names are not translated || [https://bugs.sugarlabs.org/ticket/4449 Ticket 4449] "Spanish" and other language names are not translated in My Settings language section || 72 || Martin Abente || Code, Python
|-
| Sugar Bug 4693 Send to friend not working || [https://bugs.sugarlabs.org/ticket/4693 Ticket 4693] This feature only works intermittently || 72 || Martin Abente || Code, Python
|-
| Collaboration refactoring in Story || The [https://github.com/walterbender/story Story] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Story. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Turtle Blocks || The [https://github.com/walterbender/turtleart Turtle Blocks] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Turtle Blocks. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Portfolio || The [https://github.com/walterbender/portfolio Portfolio] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Portfolio. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Reflect || The [https://github.com/walterbender/reflect Reflect] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Reflect. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Physics || The [https://github.com/walterbender/physics Physics] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Physics. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Sugar Chess || The [https://github.com/walterbender/sugarchess Sugar Chess] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Sugar Chess. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Paths || The [https://github.com/walterbender/paths Paths] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Paths. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Erikos || The [https://github.com/walterbender/erikos Erikos] (AKA Simon) activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Erikos. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Fraction Bounce || The [https://github.com/walterbender/fractionbounce Fraction Bounce] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to Fraction Bounce. || 72 || Walter || Code, Python
|-
| Collaboration refactoring in Teacher Share || The [https://github.com/walterbender/teachershare Teacher Share] activity supports collaboration through a Telepathy Tube Channel, which is deprecated. We have ported the [https://github.com/walterbender/dimensions Dimensions activity] (which also used Tubes) to use a [https://github.com/walterbender/dimensions/commits/text-channel Text Channel], which is still supported. This task is apply a similar patch to TeacherShare. || 72 || Walter || Code, Python
|-
| Turtle Confusion in Javascript || [http://activities.sugarlabs.org/en-US/sugar/addon/4450 Turtle Confusion] presents 40 shape challenges to the learner that must be completed using basic Logo-blocks. The challenges as based on Barry Newell's 1988 book, Turtle Confusion: Logo Puzzles and Riddles. This task is to implement Turtle Confusion within the framework of the [http://turtle.sugarlabs.org JavaScript version of Turtle Blocks].|| 72 || Walter || Code, JavaScript
|-
| Turtle Blocks JS: Loudness block doesn't work on Windows || [[https://github.com/walterbender/turtleblocksjs/issues/238] Issue 238 || 72 || Walter, Amit || Code, JavaScript
|-
| Turtle Blocks JS: Cannot import images on Android || [[https://github.com/walterbender/turtleblocksjs/issues/237] Issue 237 || 72 || Walter, Amit || Code, JavaScript
|-
| Turtle Blocks JS: Camera doesn't work on Android || [[https://github.com/walterbender/turtleblocksjs/issues/236] Issue 236 || 72 || Walter, Amit || Code, JavaScript
|-
| Turtle Blocks JS: Sometimes long press puts menu in wrong place. || [[https://github.com/walterbender/turtleblocksjs/issues/235] Issue 235 || 72 || Walter, Amit || Code, JavaScript
|-
| Turtle Blocks JS: Polar coordinate grid not centered under some circumstances. || [[https://github.com/walterbender/turtleblocksjs/issues/234] Issue 234 || 72 || Walter, Amit || Code, JavaScript
|-
| Turtle Blocks JS: Text rotation not saved properly in SVG output || [[https://github.com/walterbender/turtleblocksjs/issues/233] Issue 233 || 72 || Walter, Amit || Code, JavaScript
|-
| Music Blocks: Accent (Articulation) || [https://github.com/walterbender/musicblocks/issues/72 Issue 72] Articulation is a clamp block and affects all notes contained within. || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: matrix blocks don't load in collapsed state || [https://github.com/walterbender/musicblocks/issues/76 Issue 76] The matrix blocks can collapse (like start and action blocks) but the collapse state does not preserve when saving/loading project files. || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Staccato || [https://github.com/walterbender/musicblocks/issues/71 Issue 71] Staccato is a clamp block and affects all notes contained within || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Lilypond CHORDS bug || [https://github.com/walterbender/musicblocks/issues/70 Issue 70] Currently no Rhythmic Value generated for Chords || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Firefox clicking || When running Music Blocks in Firefox, there is a clicking sound with the notes. Some bug in how we are using Tone.js? This task is to track down the problem and fix it. || 72 || Walter, Devin || Code, Javascript
|-
| Music Blocks: Rhythmic Dot bug || [https://github.com/walterbender/musicblocks/issues/69 Issue 69] Dot is Calculating Rhythmic Values Incorrectly || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Matrix style 2 || [https://github.com/walterbender/musicblocks/issues/68 Issue 68] We need a "Sticky" First Column for the Matrix || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Matrix style 1 || [https://github.com/walterbender/musicblocks/issues/67 Issue 67] Columns are not Spacing Correctly in Matrix || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Repeat Block bug || [https://github.com/walterbender/musicblocks/issues/66 Issue 66] Repeat is creating parsing problem for TUPLETS in Matrix Generation || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: missing chunks || [https://github.com/walterbender/musicblocks/issues/65 Issue 65] Chunks sometimes do not show up in Palette || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks: Lilypond TUPLET bug 2 || [https://github.com/walterbender/musicblocks/issues/64 Issue 64] Scaling issue || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Lilypond TUPLET bug 1 || [https://github.com/walterbender/musicblocks/issues/63 Issue 63] Calculating sixteenth note triplets (and greater?) as "3/4" || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Play Backwards Feature || [https://github.com/walterbender/musicblocks/issues/58 Issue 58] describes a new feature: play the notes backward. || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Export Matrix as HTML file Feature || [https://github.com/walterbender/musicblocks/issues/57 Issue 57] describes a new feature: export the note selection matrix as HTML. || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Matrix highlight Bug || [https://github.com/walterbender/musicblocks/issues/56 Issue 56] describes a bug regarding highlighting the matrix || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Lilypond output || [https://github.com/walterbender/musicblocks/issues/55 Issue 55] More Robust Aggregation for LilyPond output design || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Parsing voices || [https://github.com/walterbender/musicblocks/issues/53 Issue 53] Enhancement to Lilypond output: parsing voices when note values are simultaneous || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Default Tempo enhancement || [https://github.com/walterbender/musicblocks/issues/52 Issue 52] Reset tempo on clear || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Android || [https://github.com/walterbender/musicblocks/issues/51 Issue 51] does Tonejs work on Android? is there an alternative? || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Lilypond Save Button || [https://github.com/walterbender/musicblocks/issues/50 Issue 50] Save to Lilypond button design enhancement || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks timing drifts || [https://github.com/walterbender/musicblocks/issues/49 Issue 49] We need a realtime clock || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Planet graphics || [https://github.com/walterbender/musicblocks/issues/44 Issue 44] Add some graphic for the planet upload/download || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Safari download || [https://github.com/walterbender/musicblocks/issues/37 Issue 37] Safari does not "download" the .tb files, it just opens a new window with the code in it. || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks block highlighting is inconsistent || [https://github.com/walterbender/musicblocks/issues/32 Issue 32] Notes stay lit up during debug mode. || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Invert Pitches Feature || [https://github.com/walterbender/musicblocks/issues/30 Issue 30] Invert pitches clamp based on pitch interval|| 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Skip Feature || [https://github.com/walterbender/musicblocks/issues/29 Issue 29] Play every nth note enhancement || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Transposition by Ratio || [https://github.com/walterbender/musicblocks/issues/28 Issue 28] Transposition by Ratio || 72 || Walter, Devin || Code, JavaScript
|-
| Music Block Matrix enhancements || [https://github.com/walterbender/musicblocks/issues/27 Issue 27] User Interaction for Matrix Improvement design enhancement || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks playback notes slowly || [https://github.com/walterbender/musicblocks/issues/22 Issue 22] Add slow playback step-by-step mode|| 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Synth selection || [https://github.com/walterbender/musicblocks/issues/19 Issue 19] Add support for voices/instruments/synths || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Build Newton's color scheme demo || [https://github.com/walterbender/musicblocks/issues/17 Issue 17] Program a demo of Newton's Color/Music dualilty|| 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Volume enhancement || [https://github.com/walterbender/musicblocks/issues/15 Issue 15] Make volume logarithmic || 72 || Walter, Devin || Code, JavaScript
|-
| Music Blocks Restore matrix || [https://github.com/walterbender/musicblocks/issues/13 Issue 13] Restore selected blocks in Matrix || 72 || Walter, Devin || Code, JavaScript
|-
| Add collaboration to LOL Game || [http://activities.sugarlabs.org/en/sugar/addon/4717 LOL Game] is a small sample of JavaScript activities in Sugar-Web, add Sugarizer presence API to play the game with two player || 40 || Lionel || Code, JavaScript
|-
| Write a Munin plugin to monitor network resource usage on Docker containers.||In Sugar Labs, we use Docker container to host important services. Monitoring the resource usage is critical for the infrastructure health. We have written a Munin plugin to monitor CPU and memory usage on Docker containers. The next step is to monitor the network usage on our Docker containers. This tasks requires writing a Munin plugin, preferably in Perl, for monitoring network resource usage on Docker containers. [https://docs.docker.com/articles/runmetrics/ Docker runtime metrics] [https://github.com/scanterog/munin-plugin-docker Git Repo] || 144 || Bernie || Coding
|}

== Unsorted tasks ==
=== Sugar enhancements from bugs.sugarlabs.org ===
Each of these open tickets is potential task-worthy.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Ticket !! Description !! Type !! Component
|-
| [http://bugs.sugarlabs.org/ticket/1646 1646] || No way to force-close (kill) an activity || enhancement || Sugar
|}

=== Sugar bugs from bugs.sugarlabs.org ===
Each of these open tickets is potential task-worthy.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Ticket !! Description !! Type !! Component
|-
| [http://bugs.sugarlabs.org/ticket/4307 4307] || clipboard.set_with_data/set_with_owner is not introspectable || defect || Sugar
|}

=== Activity enhancements from bugs.sugarlabs.org ===
Each of these open tickets is potential task-worthy.
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
!Ticket !! Description !! Component
|-
| [http://bugs.sugarlabs.org/ticket/758 758] || Port to new tube API || Read
|}

== Mentors ==
;NOTES TO MENTORS:
:Please refer to [[Google Code In 2015/Participate#Mentors]] for details regarding enrolling as a mentor.
:Please add yourself to the list below.
:Feel free to add new tasks to the table above.

Depending on the project, we will assign multiple mentors from our various development and support teams.

* Walter Bender - also org admin for GCI
* Sam Parkinson (student volunteer)
* Ignacio Rodriguez (student volunteer)
* German Ruiz
* Amit Kumar Jha
* Martin Abente
* Mariah Noelle Villarreal
* Gary Servin Cardozo
* Rajul Srivastava
* Julio Daniel Reyes
* Arturo Volpe
* Lionel Laské
* Bernie Innocenti
* Devin Ulibarri

0.108/Feature List

2015-11-04T10:02:31Z

SAMdroid: Add note about sugar-install-bundle taking multiple bundles

<noinclude>[[Category:FeatureList]]</noinclude>
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Owner !! Complete !! Name !! Summary !! Feature Page !! PRs !!Updated
|-
| Sam || || Replace GtkMenu || Replace the use of GtkMenu in palettes in the Sugar code || [[Features/Replace GtkMenu]] || ||
|-
| Tch || 100% || Trigger Bundle Add || Let external scripts explicitly tell the registry to add a bundle || [[Features/Trigger Bundle Add]] || [https://github.com/sugarlabs/sugar/pull/584] ||
|-
| Gonzalo || 100% || Publish Sugar Version || Publish an env variable to allow activities to know what Sugar version is running || [[Features/Publish Sugar Version]] ||
|-
| Tch || 100% || Fix bundle install issues || Activity bundle directories are now touched as a signal for installation by the BundleRegistry || [[Features/Trigger Bundle Add]] || [https://github.com/sugarlabs/sugar/pull/584] || 31 Oct ||
|-
| Sam || 5% || 'Fix' collaboration || Migrate collaboration to telepathy text channels, add abstractions, port activities || None || 31 Oct ||
|-
|}

Release noteworthy things:

* https://github.com/sugarlabs/sugar/pull/580 - When you remove the battery, Sugar does too! The battery icon is shown/hidden from the Frame when you remove/replace the battery.
* https://bugs.sugarlabs.org/ticket/3672#comment:2 - View source now gives you feedback when you duplicate an activity.
* https://github.com/sugarlabs/sugar/pull/592 - Sugar will now power off even if some activities are unresponsive.
* https://github.com/sugarlabs/sugar/pull/606 - Pressing <alt><shift>M will now launch My Settings
* https://github.com/sugarlabs/sugar/pull/608 - sugar-install-bundle now accepts multiple bundles - eg. ''sugar-install-bundle my-activity.xo your-activity.xo Downloads/*''

0.108/Feature List

2015-11-04T07:53:17Z

SAMdroid:

<noinclude>[[Category:FeatureList]]</noinclude>
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Owner !! Complete !! Name !! Summary !! Feature Page !! PRs !!Updated
|-
| Sam || || Replace GtkMenu || Replace the use of GtkMenu in palettes in the Sugar code || [[Features/Replace GtkMenu]] || ||
|-
| Tch || 100% || Trigger Bundle Add || Let external scripts explicitly tell the registry to add a bundle || [[Features/Trigger Bundle Add]] || [https://github.com/sugarlabs/sugar/pull/584] ||
|-
| Gonzalo || 100% || Publish Sugar Version || Publish an env variable to allow activities to know what Sugar version is running || [[Features/Publish Sugar Version]] ||
|-
| Tch || 100% || Fix bundle install issues || Activity bundle directories are now touched as a signal for installation by the BundleRegistry || [[Features/Trigger Bundle Add]] || [https://github.com/sugarlabs/sugar/pull/584] || 31 Oct ||
|-
| Sam || 5% || 'Fix' collaboration || Migrate collaboration to telepathy text channels, add abstractions, port activities || None || 31 Oct ||
|-
|}

Release noteworthy things:

* https://github.com/sugarlabs/sugar/pull/580 - When you remove the battery, Sugar does too! The battery icon is shown/hidden from the Frame when you remove/replace the battery.
* https://bugs.sugarlabs.org/ticket/3672#comment:2 - View source now gives you feedback when you duplicate an activity.
* https://github.com/sugarlabs/sugar/pull/592 - Sugar will now power off even if some activities are unresponsive.
* https://github.com/sugarlabs/sugar/pull/606 - Pressing <alt><shift>M will now launch My Settings

0.108/Feature List

2015-10-31T03:07:35Z

SAMdroid: I merged a few of patches today, update accordingly

0.108/Feature List

2015-10-10T08:36:45Z

SAMdroid: Add notes about battery icon change

Infrastructure Team/Contacts

2015-10-06T19:38:43Z

SAMdroid: /* Core admins */ Add myself (Sam P.)

<noinclude>{{TeamHeader|Infrastructure Team}}</noinclude>
{{TOCright}}

== Team coordinator ==
{{:Infrastructure Team/Coordinator}}

== Support and administrative requests ==

'''Please, do not cc multiple administrative contacts in the same email.''' If you do not receive an answer within 48 hours, please ping one of us by email or IRC.

;User accounts
:<accounts AT sugarlabs DOT org>
:See also [[Service/Account]]

;Sugar Labs web site and wiki
:<webmaster AT sugarlabs DOT org>
:See also [[Service/wiki]]

;Git project hosting
:<gitmaster AT sugarlabs DOT org>
:See also [[Service/git]]

;Sugar Planet
:<planetmaster AT sugarlabs DOT org>
:See also [[Sysadmin/Planet_syndication_request]], [[Service/planet]]

;DNS Management and Domains Registration
:<hostmaster AT sugarlabs DOT org>
:See also [[Service/Nameservers]]

;Other requests
:<sysadmin AT sugarlabs DOT org>

== Team Contacts ==

* Infrastructure Team mailing-list: http://lists.sugarlabs.org/listinfo/systems
* IRC: [http://chat.sugarlabs.org #sugar on FreeNode]

== Services status ==

http://identi.ca/group/sugarlabsstatus

This Identi.ca feed sends updates about the health status of all our
services and machines. Subscribe if you want to be notified.

Notifications for planned service outages are also posted ahead of time on our
"It's An Education Project" (iaep) list (check the [http://wiki.sugarlabs.org/go/Mailing_Lists#General_Lists Mailing Lists] page).

== Sysadmin Contacts ==

;For problems with a specific service (e.g. [[Service/wiki|this wiki]]): consult the specific [[Service]] page for a list of sysadmin contacts
;For problems with a server (e.g. [[Machine/sunjammer|sunjammer]]): consult the specific [[Machine]] page for a list of sysadmin contacts
;For anything else: your friendly sysadmins can be contacted at '''<sysadmin ''AT'' sugarlabs ''DOT'' org>'''

== Core admins ==

For urgent matters, the core Sugar Labs sysadmins are:

* [[User:Bernie|Bernie Innocenti]], '''bernie''' on [http://chat.sugarlabs.org/ #sugar], PGP [http://keys.sugarlabs.org:11371/pks/lookup?op=vindex&search=0x71FF4BAC 71FF4BAC]
* [[User:Dogi|Stefan Unterhauser]], '''dogi''' on [http://chat.sugarlabs.org/ #sugar] or [http://mibbit.com/?channel=%23treehouse&server=irc.oftc.net #treehouse]
[http://keys.sugarlabs.org:11371/pks/lookup?op=vindex&search=0xE810E9C1 E810E9C1]
* [[User:Sebastian|Sebastian Silva]], '''icarito''' on [http://chat.sugarlabs.org/ #sugar]
* [[User:Scg|Samuel Cantero]], '''scg''' on [http://chat.sugarlabs.org/ #sugar]
* [[User:SAMdroid|Sam Parkinson]], '''samdroid''' on [http://chat.sugarlabs.org/ #sugar]

For any non-urgent business, preferably use the official administrative contacts instead of contacting any individual system administrator directly.

== We Care (tm) ==

[[Image:Barbeque computer.jpg]]

[[Category:Contact]]

Features/Tick based animation

2015-10-05T23:22:42Z

SAMdroid:

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]
</noinclude>

== Summary ==
Smoother Animations.

Animate each frame as Gtk+ needs a new frame drawn instead of at whatever frame rate we want.

== Owner ==
* Name: Sam P.
* Email: *@sam.today

== Current status ==
* Targeted release: 0.108
* Last updated: 5 October 2015
* Percentage of completion: 75%

== Detailed Description ==
Gtk+ 3.8 introduces the idea of a 'tick'. This can have a callback attached to it. This is used to do animations in GtkPopover and the other Gtk+ widgets that have animations. Therefore, sugar should not just do out animations at 20fps. If the animation could go at 120fps because the computer is awesome, why not? If the computer is bad and it can only render 5fps, why worry about any more?

This feature can be split up into many parts:

* Toolkit implementation (100%): https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/213
* Frame and Home view (100%): https://github.com/sugarlabs/sugar/pull/505 Frame and homeview are a good spot for tick based animation as we are not cpu bound to open the frame or change views - the animation can take up 100% cpu and all will be fine
* Pulsing icon (NO-GO): https://github.com/sugarlabs/sugar/pull/513 Opening an activity is a cpu bound task, so this is probably the wrong space for animations that steal all of the cpu. This patch TRIPLES activity start times on the XO4.

== Benefit to Sugar ==
Smoother animation.

No legit, that is the only benefit.

== Scope ==
Animation consumers need to add the "widget=x" when creating an animator so they can have the tick callback attached.

Consumers who don't are not effected.

==UI Design==
None

== How To Test ==

https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/258#issuecomment-145695297

== User Experience ==
Smoother animations.

== Dependencies ==
Needs Gtk 3.8 to look different.

== Contingency Plan ==
None necessary, revert to previous release behaviour

== Documentation ==
Included in the toolkit patch

== Release Notes ==
Animations are now smoother than ever on newer hardware. Animations dynamically change FPS to leave no cpu cycle wasted.

== Comments and Discussion ==

https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/258
https://github.com/sugarlabs/sugar/pull/572

Deployment Team/Places

2015-10-05T07:27:05Z

SAMdroid: /* Oceania */ OLPC AU Switched to android

<noinclude>{{GoogleTrans-en}}{{TeamHeader|Deployment Team}}{{TOCright}}</noinclude>
=== Introduction ===

This page lists the places in the world where Sugar is used along with a contact person that will facilitate communication between the global and the local communities.

The column "# of members" is intended to give a rough estimation of the size of the local community and may include children, educators, parents, volunteers, etc

=== Asia ===

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Region
! Languages
! # of members
! Contact
|-
| '''[[Sugar_on_a_Stick_in_Delhi_India|Delhi, India]]'''
| English, Hindi
| 10
| [[USER:agoel23|Anurag Goel]]
|-
| Maharashtra, India
| English, Hindi, Marathi
| 32
| [[USER:Jpritikin|Joshua Pritikin]]
|-
| Nepal
| Nepali
| 50
| Subir Pradhanang, Rabi Karmacharya
|-
| Quezon City, Philippines
| Filipino, English
| 30
| [[USER:Jgotangco|Jerome Gotangco]]
|-
| BanSamka, Thailand
| Thai
| ~30 OLPC XO (beta-2 machines?)
| Arnan Sipitakiat?
|}

=== Africa ===

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Region
! Languages
! Software
! Hardware
! # of members
! Contact
|-
| Ethiopia
| Amharic
| ?
| OLPC XO-1
| ?
| ?
|-
| [http://www.openwijs.nl/ghana Ghana]
| English
| 820
| OLPC XO-1.0
| 4
| [mailto:f.hoff@openwijs.nl Frits Hoff]
|-
| [http://en.wikipedia.org/wiki/Mozambique Mozambique]
| Portuguese
| [[Dextrose|Dextrose-2]]
| OLPC XO-1.0
| 3000
| [[User:Bernie|Bernie Innocenti]], Melissa Henriquez
|-
| Nigeria
| English?
| 852 (updating atm)
| OLPC XO-1
| ?
| Schumberger?
|-
| Rwanda
| English?
| ?
| OLPC XO-1
| ?
| David Cavallo?
|-
| [http://bethstepsup.blogspot.com São Tomé e Príncipe]
| Portuguese
| ?
| OLPC XO-1
| ?
| [mailto:elizabeth.ann.santos@gmail.com Beth Santos]
|-
| [http://www.openwijs.nl/referenties/olpc/senegal Senegal]
| French
| 820
| OLPC XO-1.5
| in summer 2010 20
| [mailto:f.hoff@openwijs.nl Frits Hoff]
|-
| [http://www.openwijs.nl/referenties/olpc/zuid-afrika South-Africa]
| English / Zuid-Afrikaans
| 820
| OLPC XO-1.0
| February 2010 = 10, in summer 2010 > 100 of XO 1.5 laptops
| [mailto:f.hoff@openwijs.nl Frits Hoff]
|-
| [http://www.openwijs.nl/tanzania-0 Tanzania]
| English
| 820
| OLPC XO-1.0
| 100
| [mailto:f.hoff@openwijs.nl Frits Hoff]
|}

=== North America ===

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Region
! Languages
! Software
! Hardware
! # of members
! Contact
|-
| Bermingham, AL, USA
| English
| ?
| OLPC XO-1
| ?
| ?
|-
| Boston, MA, USA
| English
| SoaS Strawberry (0.84)
| HP EVO 500 desktops
| ?
| Caroline Meeks
|-
| Chiapas, Mexico
| Spanish, Tzotzil
| SoaS Strawberry on SD cards + ejabberd server
| Classmate Convertible
| 44, three rural classrooms
| [[User:Jose Icaza|Jose I. Icaza]]; [http://sites.google.com/site/tecnotzotzil TecnoTzotzil] project site in English
|}

=== South America ===

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Region
! Languages
! Software
! Hardware
! # of members
! Contact
|-
| Colombia
| Spanish
| Fedora 11/Sugar - LiveCDs - SOAS
| Desktop PCs
| 7
| RafaelOrtiz
|-
| Peru
| Spanish
| Deployment upgrading to [http://www.perueduca.edu.pe/web/visitante/docentes/articulos2010/lanzamiento-de-sugar-version8-peru Sugar 8 Peru] - Piloting [[Hexoquinasa]] in Comas
| OLPC XO-1 and XO-1.5
| 850.000
| [[User:Sebastian|Sebastian Silva]]
|-
| Paraguay
| Spanish
| [[Dextrose]]
| OLPC XO-1 + XO-1.5
| 4500 + 5000
| [[User:Bernie|Bernie Innocenti]]
|-
| Uruguay
| Spanish
| Build 802
| OLPC XO-1
| 360.000
| Pablo Flores?; [[User:Dcastelo|Daniel Castelo]]; [[User:earias|Esteban Arias]]
|-
| Chile
| Spanish
| SoaS Mirabelle
| Acer, ViewSonic, Classmate netbooks and stand alone PCs
| 25 K-3 students, Florence Nightingle School, Macul, Santiago
| [http://cl.sugarlabs.org/go/Usuario:Werner Werner Westermann], [mailto:patricio@educalibre.cl Patricio Acevedo]
|-
| Argentina - La Rioja
| Spanish
| Sugar 0.84
| OLPC XO-1.5
| 60.000
|
|}

=== Europe ===

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Region
! Languages
! # of Sugar installations
! Hardware used
! Software version
! Project blog/wiki
! Contact
|-
| Graz, Austria
| German
| 25
| XO-1
| build 767
| [http://elearningblog.phst.at/?cat=32 blog] (in German)
| David Van Assche, [[User:ChristophD|Christoph Derndorfer]]
|-
| Maastricht, the Netherlands
| Dutch
| 52
| XO-1
| build 802
| [http://www.openwijs.nl/referenties-0/maastricht-nicaragua] (in Dutch)
| [[User:OpenWijs.nl|Frits Hoff]]
|-
| London, United Kingdom
| English
| 30
| XO-1
| build 802
| [http://olpc.org.uk/ blog], [http://lists.laptop.org/listinfo/olpc-uk mailing list], [http://wiki.laptop.org/go/OLPC_UK wiki]
| [[User:PeterRobinson|Peter Robinson]], [[User:MartinDengler|Martin Dengler]]
|-
| Brescia, Italy
| Italian
| ?
| XO-1
| ?
| [http://escuola.provincia.brescia.it/olpc/ website] (in Italian)
| ?
|-
| Milan, Italy
| Italian
| 30
| XO-1
| build 802
| none
| Comunità Nuova/Barrio's - Mario Lenelli (?)
|-
| Berlin, Germany
| German
| 5 XOs, 30 laptops
| XO-1/XO-1.5, Fujitsu laptops
| build 852, F11-0.84
| [http://wiki.sugarlabs.org/go/Planetarium Planetarium], [http://erikos.sweettimez.de/?cat=3 Blog]
| Simon Schampijer
|}

=== Oceania ===

{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
|-style="background:#787878; color: white;"
! Region
! Languages
! # of members
! Contact
|-
| Solomon Islands
| Pijin, Marovo
| 300+
| David Leeming or Ian Thompson
|-
|Papua New Guinea
|?
|100
|David Leeming or Ian Thompson
|-
|Nauru
|?
|?
|David Leeming or Ian Thompson
|-
|Tuvalu
|?
|150
|David Leeming or Ian Thompson
|-
|Niue
|?
|500
|David Leeming or Ian Thompson
|-
|Cook Islands
|?
|?
|David Leeming or Ian Thompson
|-
|Vanuatu
|English, French, Bislama
|25
|David Leeming or Ian Thompson
|-
|Australia
|English and many indigenous languages
|1500
|[http://www.olpc.org.au/ Rangan Srikhanta], [[User:Tonyforster|Tony Forster]] NOTE: Switched to android
|-
|Timor Leste
|Portuguese, Tetun
|25
|Tom Daly, [[User:Tonyforster|Tony Forster]]
|}

=== See also ===

See also [[OLPC:Deployments]]

Features/Replace GtkMenu

2015-08-09T07:22:09Z

SAMdroid: Update patch links

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]
</noinclude>

== Summary ==
Get rid of Gtk.Menu based palettes - use a modal.

== Owner ==

* Name: Sam

* Email: sam@sl.o

== Current status ==
* Targeted release: 0.108
* Last updated: 7/July/2015
* Percentage of completion: 40%

== Detailed Description ==
Gtk.Menu palettes (namely, clipboard and journal) are hard to maintain and theme. They should be removed.

The only reason they are used now is because they support nesting of menus. However, a modal could be used instead.

== Benefit to Sugar ==
This will make sugar easier to maintain and reduce the amount of visual bugs.

== Scope ==
Adding a modal should be a quick process. It would probably only involve:
* Adding a modal primitive to sugar3.graphics.modal.SelectorModal` (DONE, patch: <strike>https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238</strike> https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/249)

* Migrating the 2 users of the Gtk.Menu to the modal and Gtk.Window based palettes
** The clipboard in the frame (DONE, patch: <strike>https://github.com/sugarlabs/sugar/pull/551</strike> https://github.com/sugarlabs/sugar/pull/567)
** The journal palettes

==UI Design==

Screenshots are on this pull request description https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238
===Resources (Other Platforms)===
[[File:Change-default-app-android-31.png|none|thumb|Android 4.x|484x484px]]
[[File:GNOME Modal Gedit.png|thumb|GNOME 3.16.2|333x333px|none]]
[[File:FFOS Modal.png|thumb|Firefox OS 3.0.0.0-prerelease|none]]

== How To Test ==
# Install the patches
# Open log
# Drag text to clipboard
# Right click on the clipboard item
# Click open with
== User Experience ==
Users will no longer have the open with sub-menu. This means that they will have to move their mouse more. However, the search bar will make life eaiser for power users as they can jusotsearch and press <enter>.

Users will notice that palettes look more beautiful, as they are not Gtk.Menu based.

== Dependencies ==
== Contingency Polan ==
== Documentation ==
Bits of documentation in the code, however improving them is still on the TODO list.

== Release Notes ==
''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 ==

* http://lists.sugarlabs.org/archive/sugar-devel/2015-May/050174.html
* http://lists.sugarlabs.org/archive/sugar-devel/2015-May/050209.html
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Features/Sugar3 Docs

2015-08-07T23:33:54Z

SAMdroid: /* Example Docstring */

[[Category:Feature|.]]

== Summary ==
Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your browser.

== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: @sam.today

== Current status ==
* Targeted release: 0.108
* Last updated: 8/Aug
* Percentage of completion: 10%

== Detailed Description ==
* Create a sphinx configuration file so we can have a website (DONE)
* Translate existing docs into 1 consistent style
* Write docs for all other public ''sugar3'' classes

=== Example Docstring ===

Let's just use google style doc strings, they are very clean and simmilar to the current style. [http://sphinx-doc.org/ext/example_google.html#example-google Longer example.]

<nowiki>
# GPLv3...
'''
The module does something which should be summarised here.

Example:
Something representitive of the overall module::

from example import ClassyClass

# Explain non-obvious behaviour
c = ClassyClass(a=1, b=2)
c.props.c = 3
c.thing()

STABLE.
'''

from gi.repository import GObject

class ClassyClass(GObject.GObject):
'''
The ClassyClass does blah, blah. Explain common usage pattern of
this class, such as calling the `thing` function to do a thing.

The `lol` signal is emitted when the class is laughing or when a
different non-obvious condition happens.

Args:
a (int): description of a
b (int): b could be a contrustor argument or a GObject props
that you can invoke using the **kwargs
c (int): desctiption of c
d (:class:`sugar3.graphics.alert.Alert`): remember to link
classes using the correct syntax

.. code-block:: python

c = ClassyClass()
# This is just an example of using this class
'''

def __init__(self, **kwargs):
GObject.GObject.__init__(self, **kwargs)

def thing(self, happy, lol=False):
'''
What a description for this function!

Args:
happy (bool): a description for happy
lol (bool, optional): a optional argument, explain what
it defaults to

Returns:
type: explaintaion
'''
pass
</nowiki>

== Benefit to Sugar ==
This will allow developers to create activities more eaisly. They will no longer have to look thought the source code th understand how the api works, they will instead (hopefully) have understandable docs with good working code samples.

== Scope ==
This will require lots of changes in the docstrings. However, no changes will be made to code that runs on users machines.

==UI Design==
Example docs: http://dev.sam.today/ http://dev.sam.today/sugar3.graphics.alert/ http://dev.sam.today/sugar3.graphics.animator/

== How To Test ==
* View docs
* Try code samples

== User Experience ==
None for sugar users.

== Dependencies ==
None

== Contingency Plan ==
None

== Release Notes ==
The Sugar toolkit now has imporved API documentation coverage. View our docs here: dev.sam.today (real url when it is done of course)

== Comments and Discussion ==

* https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/248
* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Features/Sugar3 Docs

2015-08-07T23:31:34Z

SAMdroid:

[[Category:Feature|.]]

== Summary ==
Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your browser.

== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: @sam.today

== Current status ==
* Targeted release: 0.108
* Last updated: 8/Aug
* Percentage of completion: 10%

== Detailed Description ==
* Create a sphinx configuration file so we can have a website (DONE)
* Translate existing docs into 1 consistent style
* Write docs for all other public ''sugar3'' classes

=== Example Docstring ===

<nowiki>
# GPLv3...
'''
The module does something which should be summarised here.

Example:
Something representitive of the overall module::

from example import ClassyClass

# Explain non-obvious behaviour
c = ClassyClass(a=1, b=2)
c.props.c = 3
c.thing()

STABLE.
'''

from gi.repository import GObject

class ClassyClass(GObject.GObject):
'''
The ClassyClass does blah, blah. Explain common usage pattern of
this class, such as calling the `thing` function to do a thing.

The `lol` signal is emitted when the class is laughing or when a
different non-obvious condition happens.

Args:
a (int): description of a
b (int): b could be a contrustor argument or a GObject props
that you can invoke using the **kwargs
c (int): desctiption of c
d (:class:`sugar3.graphics.alert.Alert`): remember to link
classes using the correct syntax

.. code-block:: python

c = ClassyClass()
# This is just an example of using this class
'''

def __init__(self, **kwargs):
GObject.GObject.__init__(self, **kwargs)

def thing(self, happy, lol=False):
'''
What a description for this function!

Args:
happy (bool): a description for happy
lol (bool, optional): a optional argument, explain what
it defaults to

Returns:
type: explaintaion
'''
pass
</nowiki>

== Benefit to Sugar ==
This will allow developers to create activities more eaisly. They will no longer have to look thought the source code th understand how the api works, they will instead (hopefully) have understandable docs with good working code samples.

== Scope ==
This will require lots of changes in the docstrings. However, no changes will be made to code that runs on users machines.

==UI Design==
Example docs: http://dev.sam.today/ http://dev.sam.today/sugar3.graphics.alert/ http://dev.sam.today/sugar3.graphics.animator/

== How To Test ==
* View docs
* Try code samples

== User Experience ==
None for sugar users.

== Dependencies ==
None

== Contingency Plan ==
None

== Release Notes ==
The Sugar toolkit now has imporved API documentation coverage. View our docs here: dev.sam.today (real url when it is done of course)

== Comments and Discussion ==

* https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/248
* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Features/Sugar3 Docs

2015-08-07T23:15:54Z

SAMdroid: Created page with ". == Summary == Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your bro..."

Features/New ASLO

2015-08-06T10:16:22Z

SAMdroid: /* Benefit to Sugar */ Add example of innovation platform

<noinclude>
[[Category:FeatureLanded|New_ASLO]]
</noinclude>

{{Note/important|WE NEED YOU!|[https://github.com/samdroid-apps/sugar-activities#sugar-activities Add you activity!]}}

== Summary ==
The new ASLO is a ground up rewrite of the aslo to make it work better for users and developers. [http://www.aslo.cf Check it out]

== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: <sam@sugarlabs.org>

== Current status ==
* Targeted release: 0.106
* Last updated: 6/8/2014
* Percentage of completion: 70%

* Number of activities: 65 (I think)

== Detailed Description ==
The ASLO is an acronym for activities.sugarlabs.org. It is an activity store, currently based off the addons.mozilla.org software.

This project is to rewrite that with software built for Sugar today. The new software will replace the web interface and updated code. The new software will add a new build pipeline and will (probably) add a command line tool for submitting activities. The dataset for the new ASLO will be [https://github.com/samdroid-apps/sugar-activities stored publicly on GitHub] rather than hidden on our servers.

== Benefit to Sugar ==
Right now, publishing an activity is a lot harder than it needs to be; making it easier gives developers more time to develop activities. The new ASLO '''automatically builds the activities and extracts metadata''' from their code/PO files. It integrates with GitHub to automatically build on push. Releasing a new version is as easy as changing the version number and "git push". Development copies are build on every push, helping get the latest versions to users who want to be more involved in the development process.

Commenting is also a very one way thing on the old ASLO; you can post a comment but developers can't reply. This is helpful to developers of Sugar - it only scares users off our activities. By integrating [[Features/SocialHelp|SocialHelp]] with the comments, the '''comments can start a discussion''' between developers and users. This will allow us to create software that better helps users. Moving the comments to [[Features/SocialHelp|SocialHelp]] also unifies the point of contact for Sugar users.

The new ASLO also '''loads faster'''. According to the Firefox Dev Tools, for ruler activity the difference is 53kb (1sec) vs 362kb (10sec) without cache. There is still an improvement with a primed cache. This comes from not using jquery or any javascript for example - this is just an app store, not interactive computer game.

Since the new ASLO uses a '''microservices''' structure, it can be simpler to maintain reliability. The web interface (what users see) can be run without any external dependencies on anything that runs docker. The backend (all the services oriented on processing activities to json) are based around a message queue for a clean service design.

The new ASLO will also provide a '''platform for innovation''' by making the dataset publicly available and versioned in git. For example, instead of manually adding forums for activities to SocialHelp, that can be automatically done with the new ASLO data.

== Scope ==
Most of the code will run on the SugarLabs servers. See the GitHub repository: https://github.com/samdroid-apps/aslo

All activities will need to be migrated from the old site and developers will need to change their workflow (if they do not already use git and push when they publish versions).

The only part that is in sugar is the updater. It was merged in 0.102, but must be enabled via gsettings.

==UI Design==
This adds a new activity store with a new look.. Check it out: https://activities-2.sugarabs.org

== How To Test ==
{{:{{PAGENAME}}/Testing}}

== User Experience ==
* New website!!!!
* Fast
* Better engagement with devs
* Cooler
* Feature parity with the old site
== Dependencies ==
None

== Contingency Plan ==
None needed.

== Documentation ==
Every section has a README loaded with information, so look at the git: https://github.com/samdroid-apps/aslo

== Release Notes ==
Switch to the new ASLO.

== Comments and Discussion ==

* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Features/New ASLO

2015-08-06T10:14:46Z

SAMdroid: Reflect project changes in mid-2015

<noinclude>
[[Category:FeatureLanded|New_ASLO]]
</noinclude>

{{Note/important|WE NEED YOU!|[https://github.com/samdroid-apps/sugar-activities#sugar-activities Add you activity!]}}

== Summary ==
The new ASLO is a ground up rewrite of the aslo to make it work better for users and developers. [http://www.aslo.cf Check it out]

== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: <sam@sugarlabs.org>

== Current status ==
* Targeted release: 0.106
* Last updated: 6/8/2014
* Percentage of completion: 70%

* Number of activities: 65 (I think)

== Detailed Description ==
The ASLO is an acronym for activities.sugarlabs.org. It is an activity store, currently based off the addons.mozilla.org software.

This project is to rewrite that with software built for Sugar today. The new software will replace the web interface and updated code. The new software will add a new build pipeline and will (probably) add a command line tool for submitting activities. The dataset for the new ASLO will be [https://github.com/samdroid-apps/sugar-activities stored publicly on GitHub] rather than hidden on our servers.

== Benefit to Sugar ==
Right now, publishing an activity is a lot harder than it needs to be; making it easier gives developers more time to develop activities. The new ASLO '''automatically builds the activities and extracts metadata''' from their code/PO files. It integrates with GitHub to automatically build on push. Releasing a new version is as easy as changing the version number and "git push". Development copies are build on every push, helping get the latest versions to users who want to be more involved in the development process.

Commenting is also a very one way thing on the old ASLO; you can post a comment but developers can't reply. This is helpful to developers of Sugar - it only scares users off our activities. By integrating [[Features/SocialHelp|SocialHelp]] with the comments, the '''comments can start a discussion''' between developers and users. This will allow us to create software that better helps users. Moving the comments to [[Features/SocialHelp|SocialHelp]] also unifies the point of contact for Sugar users.

The new ASLO also '''loads faster'''. According to the Firefox Dev Tools, for ruler activity the difference is 53kb (1sec) vs 362kb (10sec) without cache. There is still an improvement with a primed cache. This comes from not using jquery or any javascript for example - this is just an app store, not interactive computer game.

Since the new ASLO uses a '''microservices''' structure, it can be simpler to maintain reliability. The web interface (what users see) can be run without any external dependencies on anything that runs docker. The backend (all the services oriented on processing activities to json) are based around a message queue for a clean service design.

The new ASLO will also provide a '''platform for innovation''' by making the dataset publicly available and versioned in git.

== Scope ==
Most of the code will run on the SugarLabs servers. See the GitHub repository: https://github.com/samdroid-apps/aslo

All activities will need to be migrated from the old site and developers will need to change their workflow (if they do not already use git and push when they publish versions).

The only part that is in sugar is the updater. It was merged in 0.102, but must be enabled via gsettings.

==UI Design==
This adds a new activity store with a new look.. Check it out: https://activities-2.sugarabs.org

== How To Test ==
{{:{{PAGENAME}}/Testing}}

== User Experience ==
* New website!!!!
* Fast
* Better engagement with devs
* Cooler
* Feature parity with the old site
== Dependencies ==
None

== Contingency Plan ==
None needed.

== Documentation ==
Every section has a README loaded with information, so look at the git: https://github.com/samdroid-apps/aslo

== Release Notes ==
Switch to the new ASLO.

== Comments and Discussion ==

* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Obsolete Service/bugs

2015-07-25T04:32:30Z

SAMdroid: Dockerize trac

== Description ==

A [http://trac.edgewall.org/ Trac] instance for keeping track of bugs in upstream Sugar components, some activities and Rainbow.
== Hostnames ==

* http://bugs.sugarlabs.org/
* http://bugs-testing.sugarlabs.org/
* http://bugs-devel.sugarlabs.org/
== Hosted on ==

Production site runs dockerized on [[Machine/freedom]]. Data stored in the /srv/socialhelp partition

(Old) testing and devel sites run on [[Machine/sunjammer]]
== Administrative contact ==

[http://lists.sugarlabs.org/listinfo/systems systems AT lists DOT sugarlabs DOT org]
== Sysadmins ==

For non-emergency calls, preferably send email to the administrative contact.

* Sam P (email: @sam.today)
* [[User:Daniel Narvaez|Daniel Narvaez]]
* [[User:Bernie|Bernie Innocenti]]

== Notes ==

=== Cleaning user database ===

To remove inactive accounts (i.e. ones that have never been confirmed or marked as spammers):

sqlite3 /srv/socialhelp/tracproject/db/trac.db
DELETE FROM session WHERE length(sid) != 24 AND NOT EXISTS (SELECT * FROM permission WHERE username = sid);

== Upgrade notes ==
# Edit the Dockerfile (stored in /home/sam/trac or from the [https://github.com/sugarlabs-infra/trac-docker github repository]) to include the latest version of Trac (eg. change the version numbers)
# <code>container.yml start /home/sam/trac -d</code>
== See Also ==

https://github.com/sugarlabs-infra/trac-docker[[Category:Service|bugs]]

Obsolete Service/BundleBin

2015-07-18T11:53:00Z

SAMdroid: summary and container.yml

Like a pastebin, but for properly formed activity bundles (<code>.xo</code>).
== Hostnames & Emails ==

[https://bundlebin.sugarlabs.org bundlebin.sugarlabs.org]

== Hosted On ==

[[Machine/justice|Freedom]] using docker & nginx

=== Ports ===

Bundle Bin App: 5000 (on freedom)

== Setup ==

Start the docker:

container.yml start /home/sam/bundlebin -d

Service/Social Help

2015-07-18T11:51:06Z

SAMdroid: container.yml

== Hostnames & Emails ==

[https://socialhelp.sugarlabs.org socialhelp.sugarlabs.org]

[http://use.socialhelp.sugarlabs.org use.socialhelp.sugarlabs.org] (HTTP only, redirects to use-socialhelp on https)

[https://use-socialhelp.sugarlabs.org use-socialhelp.sugarlabs.org]

socialhelp AT sugarlabs DOT org

== Hosted On ==

[[Machine/justice|Freedom]] using docker

All the stuff lives in <code>/srv/socialhelp</code>

It uses the <code>socialhelp</code> partition which is 20G ext4 on the lvm

== Setup ==

First do the discourse:

cd /srv/socialhelp/discourse

<nowiki>#</nowiki> Generate the container - will take some time
sudo ./launcher rebuild app

sudo ./launcher start app --docker-args "-m 5g --cpuset='6-7'"
Most of the helpful discourse documentation is found [https://meta.discourse.org/t/how-do-i-update-my-docker-image-to-latest/23325 on their discourse forum].

Then the re director:

container.yml start /home/sam/aslo/socialhelp -d
The sso also service can be started via container.yml too. It lives in <code>/home/sam/socialhelp-sso</code>.

Service/New ASLO

2015-07-18T11:49:12Z

SAMdroid: container.yml and hook.slo

== Hostnames & Emails ==

[https://activities-2.sugarlabs.org activities-2.sugarlabs.org] (and [https://aslo.cf aslo.cf] is a redirect, along with activities2.sl.o)

[https://hook.sugarlabs.org hook.sugarlabs.org] (old subdomain, now alias: [https://aslo-bot-master.sugarlabs.org aslo-bot-master.sugarlabs.org])

== Hosted On ==

[[Machine/justice|Freedom]] using docker & nginx

[[Machine/sunjammer|Sunjammer]] hosts the bundles. It also has a webhook/cgi-script to pull the bundles from rsync://freedom.sugarlabs.org/activities2

=== Ports ===

Bot Master: 5001 (on freedom)

== Setup ==

Most services depend on the kafka queue. It is configured via docker-compose in <code>/home/sam/kafka-docker</code>.

Powered by docker containers. Setup requires is running the container.yml files found in the subdirectories of the [https://github.com/samdroid-apps/aslo ASLO repo]. Eg:

container.yml start /home/sam/bot -d
You also want to have the [[Service/Social Help|social help service]] running as well for the comments system.

Service/wiki

2015-07-18T11:42:36Z

SAMdroid: Move parsoid to container.yml

<noinclude>
[[Category:Wiki]]
[[Category:Service|wiki]]
</noinclude>
Statistics: http://stats.sugarlabs.org/wiki.sugarlabs.org/
== Hostnames ==

* [http://wiki.sugarlabs.org wiki.sugarlabs.org]
* [http://wiki-devel.sugarlabs.org wiki-devel.sugarlabs.org]
* [http://pe.sugarlabs.org pe.sugarlabs.org]
* [http://cl.sugarlabs.org cl.sugarlabs.org]
* [http://co.sugarlabs.org co.sugarlabs.org]
* [http://ar.sugarlabs.org ar.sugarlabs.org]

== Hosted on ==

[[Machine/sunjammer]]

== Administrative contact ==

<webmaster ''at'' sugarlabs.org>

== Account Creation ==

* See https://www.mediawiki.org/wiki/Manual:Preventing_access#Restrict_account_creation
* Create account page: https://wiki.sugarlabs.org/index.php?title=Special:UserLogin&type=signup

== Local Labs contacts ==

* Peru: [[User:Sebastian|Sebastian Silva]]
* Colombia: Cristian Paul Peñaranda Rojas
* Argentina: Gustavo Ibarra

Local labs, please confirm contacts and add links.

== Sysadmins ==

* [[Wiki Team/Contacts]] for wiki content and user accounts
* [[User:Bernie|Bernie Innocenti]] for hosting issues
* [[User:Sebastian|Sebastian Silva]] for the Local Labs wikis

== Wiki instances ==

The main wiki lives here at <code>/srv/www-sugarlabs/wiki/</code>

Except for trivial changes, work on the wiki should be carried on
in the parallel wiki-devel instance before landing onto the production instance.

{{Highlight|'''Note:''' The devel wiki has an outdated snapshot of the page database and its own slightly different server configuration.}}

Sometimes the devel instance contains interim work performed by various wiki helpers. Do not sync changes blindly to the
production wiki!

Before overwriting the page database, please
* observe http://wiki-devel.sugarlabs.org/go/Category:Under_construction
* announce the plan on systems@ and to any collaborators who have signed their 'Under construction' pages in the template (such as by using the 'E-mail this user' link in the sidebar for the wiki user's page, even when it is a red link or not yet created).

== Creating a Local Labs wiki ==

* Add a group for the wiki (vigr)

cd /srv/www-sugarlabs
cp -a co.sugarlabs.org pe.sugarlabs.org
chown -R icarito:sugarwiki-pe pe.sugarlabs.org
cd pe.sugarlabs.org/wiki
rm -r images/*
vim LocalSettings.php
vim SecretSettings.php

* Create apache virtual host:

cp -a /etc/apache2/sites-available/pe.sugarlabs.org /etc/apache2/sites-available/ar.sugarlabs.org
vim /etc/apache2/sites-available/ar.sugarlabs.org
a2ensite ar.sugarlabs.org

* Create DB with some clever trick. I reused <code>config/index.php</code> to setup a new MediaWiki instance and then I've thrown away the generated <code>LocalConfig.php</code>:

mv LocalConfig.php LocalConfig.good
cp -a /srv/www-sugarlabs/co.sugarlabs.org/config .
(go to http://ar.sugarlabs.org/wiki/config/index.php)
rm -r config LocalConfig.php
mv LocalConfig.good LocalConfig.php

* Create tables for OpenID:

mysql -u root -p pe_sugarlabswiki < extensions/OpenID/openid_table.sql

== Installation ==

Our MediaWiki instances are installed from git to allow easy rebasing of our changes on upgrades.

git clone https://gerrit.wikimedia.org/r/p/mediawiki/core.git wiki-devel
cd wiki-devel
git co -b REL1_19 remotes/origin/REL1_19
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions.git extensions-all
cd extensions-all
git submodule update --init
cd ../extensions
# for each needed extensions
ln -s ../extensions-all/EXT

For the full details on this installation method, see http://www.mediawiki.org/wiki/Download_from_Git

== Visual Editor ==

This wiki has the VisualEditor extension.

In order to do that, we need the parsoid node js service. Since Sunjammer is running too old of a version, this service is hosted on freedom. It can be started using:
container.yml start /home/sam/parsoid -d
And is accessed at http://freedom.sugarlabs.org:8001/

== Upgrade notes ==

We update our MediaWiki instances by simply pulling from the remote git repo and then switching to a
different stable branch:

git pull
git co -b REL1_xx remotes/origin/REL1_xx

The "extensions-all" directory contains a bunch of git repositories stitched together with 'git submodule'.
To update it:

cd extensions-all
git submodule update

Now run update script:

php maintenance/update.php

In the case of Local Labs wikis the correct command for performing the updates is:

php maintenance/update.php --conf /srv/www-sugarlabs/pe.sugarlabs.org/wiki/LocalSettings.php
(replace pe.sugarlabs.org for the correct path for your local lab w)

If the SemanticMediaWiki extension is enabled (we don't use it), also refresh its tables:

cd extensions/SemanticMediaWiki/maintenance
php SMW_setup.php

Features/Replace GtkMenu

2015-07-07T04:39:42Z

SAMdroid:

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]
</noinclude>

== Summary ==
Get rid of Gtk.Menu based palettes - use a modal.

== Owner ==

* Name: Sam

* Email: sam@sl.o

== Current status ==
* Targeted release: 0.108
* Last updated: 7/July/2015
* Percentage of completion: 40%

== Detailed Description ==
Gtk.Menu palettes (namely, clipboard and journal) are hard to maintain and theme. They should be removed.

The only reason they are used now is because they support nesting of menus. However, a modal could be used instead.

== Benefit to Sugar ==
This will make sugar easier to maintain and reduce the amount of visual bugs.

== Scope ==
Adding a modal should be a quick process. It would probably only involve:
* Adding a modal primitive to sugar3.graphics.modal.SelectorModal` (DONE, patch: https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238)

* Migrating the 2 users of the Gtk.Menu to the modal and Gtk.Window based palettes
** The clipboard in the frame (DONE, patch: https://github.com/sugarlabs/sugar/pull/551)
** The journal palettes

==UI Design==

Screenshots are on this pull request description https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238
===Resources (Other Platforms)===
[[File:Change-default-app-android-31.png|none|thumb|Android 4.x|484x484px]]
[[File:GNOME Modal Gedit.png|thumb|GNOME 3.16.2|333x333px|none]]
[[File:FFOS Modal.png|thumb|Firefox OS 3.0.0.0-prerelease|none]]

== How To Test ==
# Install the patches
# Open log
# Drag text to clipboard
# Right click on the clipboard item
# Click open with
== User Experience ==
Users will no longer have the open with sub-menu. This means that they will have to move their mouse more. However, the search bar will make life eaiser for power users as they can jusotsearch and press <enter>.

Users will notice that palettes look more beautiful, as they are not Gtk.Menu based.

== Dependencies ==
== Contingency Polan ==
== Documentation ==
Bits of documentation in the code, however improving them is still on the TODO list.

== Release Notes ==
''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 ==

* http://lists.sugarlabs.org/archive/sugar-devel/2015-May/050174.html
* http://lists.sugarlabs.org/archive/sugar-devel/2015-May/050209.html
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

Features/Tick based animation

2015-07-04T00:35:29Z

SAMdroid: Created page with "<noinclude> Category:Feature Page Incomplete . </noinclude> == Summary == Animate each frame as Gtk+ needs a new frame drawn instead of at whatever f..."

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]
</noinclude>

== Summary ==
Animate each frame as Gtk+ needs a new frame drawn instead of at whatever frame rate we want.

== Owner ==
* Name: Sam P.
* Email: *@sam.today

== Current status ==
* Targeted release: 0.108
* Last updated: 4 July 2015
* Percentage of completion: 50%

== Detailed Description ==
Gtk+ 3.8 introduces the idea of a 'tick'. This can have a callback attached to it. This is used to do animations in GtkPopover and the other Gtk+ widgets that have animations. Therefore, sugar should not just do out animations at 20fps. If the animation could go at 120fps because the computer is awesome, why not? If the computer is bad and it can only render 5fps, why worry about any more?

This feature can be split up into many parts:

* Toolkit implementation (100%): https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/213
* Frame and Home view (100%): https://github.com/sugarlabs/sugar/pull/505 Frame and homeview are a good spot for tick based animation as we are not cpu bound to open the frame or change views - the animation can take up 100% cpu and all will be fine
* Pulsing icon (20%): https://github.com/sugarlabs/sugar/pull/513 Opening an activity is a cpu bound task, so this is probably the wrong space for animations that steal all of the cpu.

== Benefit to Sugar ==
Smoother animation.

No legit, that is the only benefit.

== Scope ==
Doesn't break anything.

Animation consumers need to add the "widget=x" when creating an animator so they can have the tick callback attached.

==UI Design==
Some animations (aka. plusing icon) look completely different when they are actually smooth.

== How To Test ==

1. Apply the patches <https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/213> and <https://github.com/sugarlabs/sugar/pull/505>
2. Open the frame and notice the smoothness
3. Press F6 over and over again to enjoy all the frames in the animation
4. Change between home views (F1-F3) to enjoy the smoothness of the animating size of the xo-person

== User Experience ==
Smoother animations.

== Dependencies ==
Needs Gtk 3.8 to look different.

== Contingency Plan ==
None necessary, revert to previous release behaviour

== Documentation ==
add the widget=x

== Release Notes ==
Animations are now smoother than ever on newer hardware. Animations dynamically change FPS to leave no cpu cycle wasted.

== Comments and Discussion ==

All the pull requests

Sysadmin/Add shell account

2015-06-24T07:32:05Z

SAMdroid: remote-useradd should no longer be run as root

'''Users looking for a Sugar Labs account should go to [[Service/Account]].'''

== Guidelines ==

Ask users to follow diligently the [[Service/shell#Requesting_a_shell_account]] procedure.

Users should briefly motivate their request. A sufficient justification could be:
"I have these Sugar-related files that I'd like to distribute on people.sugarlabs.org".

'''Shell accounts shouldn't be granted to untrusted individuals without referrals.'''
'''Shell accounts that are known to be unused should be disabled with <tt>system-userdel</tt>.'''

== Account creation on shell.sugarlabs.org ==

To create an account, become root on [[Machine/sunjammer]] and type:

system-useradd <username> <first_name> <last_name> <email>

* Note that accents in the first_name or last_name would break the script.
* '''NOTE: You have to become root with 'sudo -i'. Prefixing the command with sudo won't work because it doesn't switch $HOME to /root, which is necessary to make the ldap commands source <code>/root/.ldaprc</code>.'''

At some point the script will prompt you to paste the user's ssh key.
You can skip this part and edit ~user/.ssh/authorized_keys manually.

The procedure automatically sends a welcome email to the user.
The email is also copied to ~user/welcome, in case they loose the
original message.

== Adding accounts on other machines ==

Please '''do not create accounts directly with useradd!''' Instead, copy the existing credentials from sunjammer:

* Log into sunjammer, forwarding your ssh keys with the ssh-agent:

ssh -A sunjammer

* Run this shell script to create a user and copy the credentials from sunjammer:

remote-useradd <remotehost> <user> <groups...>

Needless to say, remote-useradd requires your ssh key to be already installed in the remote server.

Typically, you'll want to add users to groups <tt>sudo</tt>, <tt>adm</tt>, <tt>libvirtd</tt> and <tt>docker</tt>.

== See also ==
* [[Sysadmin/User_management]] -- all other operations on user accounts
* [[Service/Account]] -- Account information for users
* [[Service/shell]] -- ssh access to shell.sugarlabs.org
* [[Machine/sunjammer]] -- shell account server

Talk:Features/Start activity from another activity

2015-05-26T06:43:56Z

SAMdroid: /* Test cases? */

== Test cases? ==

Apart from Manuq's hello-world test case, are there any activities that use this feature yet? Very hard for people to test the feature if nothing uses it! --[[User:Quozl|Quozl]] ([[User talk:Quozl|talk]]) 22:12, 25 May 2015 (EDT)
: I have updated the page. Please see the new browse version (157.1) [[User:SAMdroid|SAMdroid]] ([[User talk:SAMdroid|talk]]) 02:43, 26 May 2015 (EDT)

Features/Start activity from another activity

2015-05-26T06:39:29Z

SAMdroid: /* How To Test */

<noinclude>
[[Category:Feature|Start activity from another activity]]
</noinclude>

== Summary ==

This feature provides a new way of interoperability between
activities, the current ones being the Journal and the Clipboard.

Activities are provided with a new API to call other activities. This
API allows the expression of phrases such as "read this book" or "edit
this code with that editor".

This is important for activities that handle sets of objects. For
example a gallery of images, a content catalog.

== Owner ==
* Name: [[User:Manuq| Manuel Quiñones]]

== Current status ==
* Targeted release: 0.106
* Last updated: May, 2015
* Percentage of completion: 100%

== Detailed Description ==

One of Sugar key principles is simplicity. Activities are meant to be
simple, and users can make interesting things happen when they
interoperate with them. Currently, they do so by using the Journal
and the Clipboard.

However, there are cases where you want to start an activity from
inside another, thus skipping the step through the Journal.

This feature provides a third way of interoperability between
activities.

For example, an activity whose purpose is to download content, would
like to display the content right away.

The following considerations are made.

* This solution is based on current activities, ie does not imply a change in activities. It uses the available information that Sugar has now:
** the bundle registry
** the activity declared mime types
** the metadata in datastore objects

* This solution is for every bundle, not just activities. This includes content bundles.

* This solution considers Rainbow security.

An activity can start other activity by:

* knowing the activity ID - starts that specific activity

* passing a datastore object - if the activity ID is also passed, starts the object with that specific activity. Otherwise starts the first activity that can handle the object.

* passing a mime type - if the activity ID is not passed, start the first activity that can handle the mime type.

An error is reported to the user of the API if the request couldn't be
accomplished, with a message. For example "no activity can start this
object" or "activity with ID XYZ not found".

=== Implementation ===

The code that starts activities in Sugar currently lives in the
Journal. The idea is to move the code to a more general module in
Sugar, and make the Journal a user of it. Then, add a DBUS service so
that the activitie's toolkit can use the API too.

== Benefit to Sugar ==

This will enhace the interoperability of Sugar activities, removing
the need to pass through the Journal in the cases where it makes sense
and feels indirect or complicated. Thus, is an enhacement of the user
experience.

The lack of this capability made Uruguay deployment (Ceibal) go for a
custom solution regarding content obtention and consumption. They
mixed the capabilities of activities GetBooks, Read and Jukebox into a
monolithic activity "Biblioteca Segura".

== Scope ==

This feature affects only Sugar modules. Current activities can take
advantage of the new API provided by this feature.

The Journal is adapted to be a user of this API. In fact, all the
code is adapted from the Journal code.

==UI Design==

Video that shows the user experience:
https://dl.dropboxusercontent.com/u/588753/start.webm

There is no UI in this feature. Activities that currently have a
button "Show in Journal" can move to this API and change the button
label to "Start" or "Display" or something more specific like "Read
Book" or "Edit Code".

== How To Test ==
* File download in browse 157.1+ <https://github.com/sugarlabs/browse-activity>

=== Original ===
Demo in a branch of Hello World:
https://github.com/manuq/hello-world/tree/start-activity. '''NOTE''': This uses an older version of the api so it is not 100% compatible.

Current API:
https://github.com/manuq/hello-world/blob/start-activity/activity.py#L124

Changes in sugar
* branch: https://github.com/manuq/sugar/tree/start-activity
* comparison: https://github.com/manuq/sugar/compare/start-activity?expand=1
* patch: https://github.com/manuq/sugar/compare/start-activity.patch

Changes in sugar-toolkit-gtk3
* branch: https://github.com/manuq/sugar-toolkit-gtk3/tree/start-activity
* comparison: https://github.com/manuq/sugar-toolkit-gtk3/compare/start-activity?expand=1
* patch: https://github.com/manuq/sugar-toolkit-gtk3/compare/start-activity.patch

== User Experience ==

UX enhacement is described in the section above "Benefit to Sugar".

== Dependencies ==

This feature does not depend on the completion of other features.

== Contingency Plan ==

Not including.

== Documentation ==

=== Previous attempts ===

In 2011 Martin Abente (tch) sent a patch that enhaced sugar-launch
http://marc.info/?l=olpc-sugar&m=129485435106175&w=2

As discussed in the mailing list, this solution is not appropiate
because it skips Rainbox security (http://wiki.laptop.org/go/Rainbow)
in secured systems, and seems odd that the child activity process is
spawned from the parent activity process. Sugar "the shell" should
spawn the activity processes.

=== Android Intents as reference ===

I loosely based this feature in Android Intents:

http://developer.android.com/reference/android/content/Intent.html

Android has a similar mechanism than the proposed here. Is much more
powerful and used system-wide and also internally per application.
Android apps are made of components, and those components declare
which actions can perform as intent filters. Using a data structure
called Intent, one component can call an action of another component.
That data stracture holds an abstract description of the action to be
performed. Android has an intent resolution mechanism to determine
the component that matches the intent.

The main similarities and differences are:

* Currently we can only have one action: "Start" that launches an activiy. Our activities are not made of components like Android apps. If that were the case, we could be able to do neat things like "take a photo" from any activity, that would call the correspondent component of Record or other available activity to take a photo from the camera. This is a major change that implies a change in activities, so is out of the scope of this feature.

* Android Intents use a URI for data, usually a content provider like "content://..". The current way to reference an object in Sugar is by its ID. Currently, we can't pass arbitrary data to an activity.

* In Android, the component to be called can be implied from the data. We do the same. Our components are the Sugar bundles.

* In Android, extra data can be passed. We can't do that in current activities.

* In Android, the mime type can be explicit or implied from the data. We do the same.

== Release Notes ==

To be written.

== Comments and Discussion ==

Your comments are very welcome. Please discuss through the mailing list.

* First discussion on the mailing list:
http://lists.sugarlabs.org/archive/sugar-devel/2014-January/046911.html

Talk:Features/Social Help

2015-05-25T09:30:47Z

SAMdroid: /* Missing content */

== Missing content ==

This feature page does not mention:

* that an account must be created by the learner,
* that the learner must have an e-mail account,
* whether a cookie for the account remains on the device,
* a privacy policy,

--[[User:Quozl|Quozl]] ([[User talk:Quozl|talk]]) 04:59, 20 May 2015 (EDT)

: Cookies are stored in the user's sugar profile directory. It is persistent between usages
:
: As for your other comments, they are 100% dependent on the user's or deployment's configured server.
:
: On socialhelp.sl.o (the default server):
: * We use discourse, and email and accounts are very central to discourse. Discourse is a very good piece of software and I suppose this is a compromise I am willing to make.
: * Accounts could be pre-created by deployments or kids could ask questions using a teachers account
: * We have a very stock standard privacy policy <https://socialhelp.sugarlabs.org/privacy>, it is very simple to understand and I recommend reading it. It does have a bad policy on COPPA, which is an issue to fix.