Sugar Labs - User contributions [en]

Service/translate

2021-08-28T14:17:45Z

Srevin03: Add location to pootle configuration, from Ibiam, Alex Perez

== Hostnames ==

* http://translate.sugarlabs.org/

== Hosted on ==

[[Machine/pootle]]

== Administrative contact ==

* translate AT sugarlabs DOT org

== Sysadmins ==

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

* [[User:Sebastian|Sebastian Silva]] has assumed maintainership tasks
* [[User:Cjl|Chris Leonard]] has Pootle administrator privs, and heads the localization efforts.
* [[User:Bernie|Bernie Innocenti]] has system admin and Pootle administrator privs, but takes care only of OS-level administration.
* [[User:SayaminduDasgupta|Sayamindu Dasgupta]] is the former admin. He still has an emeritus sysadmin account and he can be very helpful if contacted by email.

== Language Administrators ==

Language administrators are typically native speakers of a given language that take on responsibility (granted by a Pootle administrator after a request to the Localization list) for reviewing and committing PO files for a given language. Contacting language administrators is generally done by posting to the Localization list.

More information on language administrator duties can be found on [[Translation_Team/Administration_QuickStart|this page]]

== Notes ==

{| class="wikitable"
|-
!scope="row" | Home
|{{Code|/var/lib/pootle}}
|-
!scope="row" | Daemon
|
{{Code|/etc/init.d/apache2}} 
{{Code|/etc/init.d/pootle}}
|-
!scope="row" | Logs
|{{Code|/var/log/apache2}}
|-
!scope="row" | Config
|
{{Code|/etc/apache2/sites-enabled/000-default}} 
{{Code|/etc/cron.d/pootle}} 
{{Code|/var/www/pootle/sugarlabs/pootle.conf}} 
|-
!scope="row" | Ports
|
{{Code|80}} HTTP server
|-
|}

== Upgrade notes ==

*A backup of the DB and pootle localsettings.py must be done also.
*Backup of the /var/lib/pootle structure
*New versions of Django and Translate toolkit must be installed first
*Restore localsettings and DB backup

== Mantainance Notes ==

Pootle in Sugar is maintained. (icarito has step-up to be maint)

== Migrated to Pootle 2.5.0 ==

Notes on the process were recorded here: [[Service/translate/Pootle2.5]]

== Files ==

Important files and directories in the root directory, {{Code|/var/lib/pootle}}.

{{Code|'''checkouts'''}} 
Sources are checked out in this directory and being used to keep final {{Code|.pot}} and {{Code|.po}} files. The hierarchy is:

checkouts/''pootle-project''/''pootle-po-filename-without-po-suffix''/''sources''

{{Code|'''translations'''}} 
Pootle uses this directory as a sources of files to translate, it contains symlinks to files from the {{Code|checkouts}} directory. The hierarchy is:

translations/''pootle-project''/''lang''/''symlinks-to-po-files''

{{Code|'''maintenance'''}} 
Contains some sugar-specific scripts to help maintain our Pootle instance, they are managed in http://git.sugarlabs.org/projects/pootle-helpers.

{{Code|'''maintenance/helpers/potupdater/project_list.ini'''}} 
This is an Ini file that contains configuration for all used sources repositories. Each section describes one sources repository, where section name is full path, in form of {{Code|/var/lib/pootle/checkouts/''pootle-project''/''pootle-filename''/''some-path-within-sources''/''pot-file''}}, to the {{Code|.pot}} file, and contains following options:

* {{Code|project}} required, meaning-less project name;
* {{Code|vcs}} required, the type of VCS for; supported values are: {{Code|git}};
* {{Code|method}} required, the method how to generate {{Code|.pot}} files from sources; supported values are: {{Code|bundlebuilder}} for activities, {{Code|intltool}} for intltool based projects;
* {{Code|layout}} required, ?;
* {{Code|ignore-files}} optional, the semicolon separated list of file paths that are relative to the sources root; if {{Code|method}} is {{Code|bundlebuilder}} this value will be used to ignore while producing {{Code|.pot files}};

== Tools ==

* {{Code|potupdater/pogenerator.py}} pulls from git and svn so we have updated sources, then it generates a new .pot file from them. Translated strings get reflected in the .po files in each module, and when the language maintainer clicks the Commit to VCS link, get pushed back to the upstream module.
* {{Code|admin/pootlepopulator.py}} checkout sources.
* {{Code|misc/pootle.cron}} all daily basis routines.
* ''...''

== Tips ==

=== Create new Pootle project ===

* Create new project in Pootle admin menu, ''admin->projects'';
* Add all needed langs;
* Checkout all sources using command:

sudo -u pootle -i python maintenance/helpers/admin/pootlepopulator.py ''pootle-project'' ''git-clone-url'' ''pootle-filename-wo-po-suffix'' ''git-branch''

Example:

To checkout the sugar in the branch sucrose-0.94 (in pootle is in the project glucose94) we sshould do:

cd /var/lib/pootle/
sudo -u pootle -i python maintenance/helpers/admin/pootlepopulator.py glucose94 gitorious@git.sugarlabs.org:sugar/mainline.git sugar sucrose-0.94

* Add new sections to the [[#Files|project_list.ini]] file to describe new {{Code|.pot}} locations;
* Run {{Code|misc/pootle.cron}} script from {{Code|pootle}} user to generate all sufficient files;
* Click ''rescan the project files'' in ''Templates->Project->Files'' to reveal newly created {{Code|.pot}} files;
* Click ''Update from templates'' for all languages in newly created project to peek up {{Code|.po}} files symlinked by {{Code|misc/pootle.cron}} script.

=== Adding activities ===

Before registering new activity on http://translate.sugarlabs.org, make sure that:

* New activity is being hosted on http://git.sugarlabs.org;
* The {{Code|pootle}} user was added to the repository with commit access rights;
* You have a proper {{Code|GIT_URL}} to clone repository from with commit permissions, e.g., {{Code|gitorious@git.sugarlabs.org:cartoon-builder/mainline.git}}; that might be found on home page in Gitorious, e.g., http://git.sugarlabs.org/cartoon-builder, in ''Clone & push urls'' field with selector ''SSH'';
* You know the proper {{Code|CATEGORY}} name to register the project in;
* There is an unique {{Code|NAME}} of activity, this name will be used as a name of project in Pootle and directory name;
* You know the proper {{Code|BRANCH}} in Git repository to use for translation; by default, it is {{Code|master}}.

To process the registration, login to translate.sugarlabs.org and enter:

sudo -u pootle python /var/lib/pootle/maintenance/helpers/admin/pootlepopulator.py ''<CATEGORY>'' ''<GIT_URL>'' /var/lib/pootle/checkouts/''<CATEGORY>''/''<NAME>'' [''<BRANCH>'']

After that, for [http://git.sugarlabs.org/pootle-helpers pootle-helper] project in {{Code|potupdater/project_list.ini}}, add the following strings:

[/var/lib/pootle/checkouts/''<CATEGORY>''/''<NAME>''/po/''<.pot-filename>'']
project = ''<NAME>''
vcs = git
method = bundlebuilder
layout = gnu

Commit new changes, and pull from on pootle VM:

(cd /var/lib/pootle/maintenance/helpers; sudo -u pootle git pull origin master)

Do ''update from templates'' on the ''templates'' project on Pootle's frontend. And wait until daily cron job will populate languages for newly registered project, or run it immediately:

sudo -u pootle python /var/lib/pootle/maintenance/helpers/admin/add_langs.py

Then your activity must be in place to be translated and ''commit to VCS/update from VCS'' links must be activated.

=== Working with git in the pootle server ===

The git operations must be done by the pootle user:

sudo -u pootle git log

sudo -u pootle git push origin sucrose-0.82

This script tell you when you can update different clones of activities, when new strings are added via gettext in each repo.

/var/lib/pootle/maintenance/helpers/potupdater/check_unmerged_translations.sh

Other important script is pogenerator.py this script re-generates pot in each repo.

=== Resolving conflicts ===

If the maintainer did a commit with a file in the po directory we will have a conflict, and Pootle can not do a pull.

Pootle build the pot file from the sources, if we compare and the translations are updated in pootle
we can do a pull preserving the info in pootle:

sudo -u pootle git pull -s ours

=== Checking that pootle is working ===

* When commiting from pootle interface, repos in git reflect the commit as something similar to:

pootle pushed 3fd0cf7b to taportfolio/mainline:master
on March 04, 2011 01:32
Commit from Sugar Labs: Translation System by user cjl.: 2 of 25 messages translated (0 fuzzy).

* Pogenerator.py (in cronjob), it's also giving mails with info like:

Already up-to-date. or
####### Checking POT for Write (master) ######

=== Etoys .pot update ===

Go to Etoys translation directory (that is svn checkout from upstream project):

su - pootle
cd ~/translations/etoys_new

Since there is no need in changing .pot files on Pootle level, revert local changes if they present:

svn revert templates/*.pot

Fetch new update from the upstream:

svn up templates

=== Tips ===

* How to manipulate users:

django-admin shell --settings=pootle.settings
>>> from django.contrib.auth.models import User
>>> u = User.objects.get(username='bernie')
>>> u.is_superuser = True
>>> u.save()

* Refresh stats, needed when the database and the checked out modules get out of sync:

sudo -u pootle django-admin refresh_stats --settings=pootle.settings

* If you have a commit error file because of only read git url, please rm the old '''/var/lib/pootle/checkouts/''' files related with that activity or project and re run pootlepopulator.

* Also if there are errors related with git add, is likely that some lang.po files are not versionated on pootle server, please run '''git add .''' inside the activity or project.

* When there are '''commit to cvs/update to cvs''' links missing in activities or projects please check git url in .git/config , this URL must be writable by pootle.

== References ==

* http://translate.sourceforge.net/wiki/pootle/installation
* http://lists.laptop.org/listinfo/localization
* http://git.sugarlabs.org/pootle-helpers
* /usr/lib/python2.6/dist-packages/translate/storage/versioncontrol/git.py (Translate)

[[Category:Service|translate]]

Grafana

2021-08-09T18:19:51Z

Srevin03: Add grafana docs

Sugar Labs uses Grafana to monitor new VMs and services. Previously, Sugar Labs used Munin, which is being migrated slowly to Grafana.

Grafana runs on sunjammer.sugarlabs.org, and is accessible at https://grafana.sugarlabs.org

== Install ==
Follow the instructions specified on https://grafana.com/docs/grafana/latest/installation/debian/ for the latest instructions.

== Update ==
Grafana is installed as an ubuntu PPA, that means, it should automatically get updated when you update your system

== Configuration ==
Grafana stores its configuration at /etc/grafana/grafana.ini

To create an account on Grafana, contact sysadmin.

Grafana is the web frontend to view the monitoring logs which are provided by prometheus.
Prometheus periodically polls the output of Prometheus Node Exporter, both of which runs as
systemd service.

There are different exporters for different kind of services, like exporters for Apache, Nginx, MySQL / MariaDB, etc.

Machine/sunjammer

2021-06-22T19:06:39Z

Srevin03: add specifications

<noinclude>{{TOCright}}</noinclude>

[[Image:Sunjammer.jpg|right|320px]]

== Info ==

This is our development and community shell server, also running a number of first-tier
web services.

== Services ==

The following services are hosted on sunjammer:

* [[Service/email]]
* [[Service/shell]]
* [[Service/imap]]
* [[Service/smtp]]
* [[Service/jabber]]
* [[Service/lists]]
* [[Service/wiki]]
* ...countless others...

== Sysadmin procedures ==

The following sysamin procedures apply to sunjammer:

* [[Sysadmin/User management]]
* [[Sysadmin/Add shell account]]
* [[Sysadmin/Content Delivery Network]]
* [[Sysadmin/Quota]]
* [[Sysadmin/SSL Certificates]]

See [[Infrastructure_Team/Resources]] for the complete list of our sysadmin procedures.

See <tt>/root/memo</tt> on sunjammer for local sysadmin procedures that have not yet been converted to wiki pages.

== Location ==
Sunjammer is a XEN domU running on [cloud9.fsf.org].

The dom0 is hosted by the [http://www.fsf.org/ Free Software Foundation] at the [http://www.gnaps.com/ Global NAPs] collocation facility.

== Specifications ==
* KVM/QEMU (Standard PC (i440FX + PIIX, 1996) pc-i440fx-xenial)
* AMD Opteron 62xx class (6) @ 2.100GHz
* 6 CPU Cores
* 7961MiB RAM

== Hardware ==

* [http://www.siliconmechanics.com Silicon Mechanics] [http://www.siliconmechanics.com/i7288/opteron-server.php Rackform nServ A266].
* 2.4GHz quad-core Opteron
* 64GB RAM

== Network configuration ==
* 1 Gbit global IPv4 through FSF's BGP router
* 1 Gbit global IPv6 (6to4)
* 1GbE crosslink to [[Machine/treehouse]]

== Backups ==

Live incremental backup of all filesystems pulled daily by [[Machine/housetree]]
over the crosslink gigabit ethernet with rsync.

The latest backup can be retrieved from these locations:

* housetree.sugarlabs.org:/backup/sunjammer/root/
* housetree.sugarlabs.org:/backup/sunjammer/srv/

We keep 7 days of history in .backup/[1-7]/ using hardlinks.

We also perform a daily system-remote-backup to [[Machine/backup]], encrypted with GPG key of [[User:bernie]].

== Admins ==

'''DO NOT CONTACT THE ADMINS DIRECTLY FOR USER SUPPORT - USE THE sysadmin@ ALIAS'''

Admins with root access:

* [[User:MrBIOS|Alex Perez]], '''aperezbios''' on [https://chat.sugarlabs.org/ #sugar] Freenode
* [[User:Scg|Samuel Cantero]], '''scg''' on [https://chat.sugarlabs.org/ #sugar] Freenode
* [[User:Bernie|Bernie Innocenti]] (emeritus)
* [[User:Srevin03|Srevin Saju]], '''srevinsaju''' on [https://chat.sugarlabs.org/ #sugar] Freenode

Admins with physical access:

* FSF Sysadmin RT <sysadmin ''at'' fsf.org>

Service/www

2021-06-06T16:41:44Z

Srevin03: add a link to https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll

== Description ==

The SugarLabs front page.

Managed with the Jekyll CMS, it contains static articles describing the project.

== Hostnames ==

* http://www.sugarlabs.org

== Hosted on ==

[https://pages.github.com/ GitHub Pages]

== Administrative contact ==

marketing AT sugarlabs DOT org

== Sysadmins ==

Send email to the systems sugar labs list.

== Notes ==

The website is hosted from sugarlabs.github.io (GitHub Pages). The website will be automatically refreshed on every commit to
its [https://github.com/sugarlabs/www-sugarlabs Github Repository]. For more information on how the GitHub Jekyll website builder
works, see https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll .

[[Category:Service|www]]

Service/www

2021-06-06T07:13:02Z

Srevin03: Update the www build instructions

Matrix

2021-05-28T08:51:13Z

Srevin03: /* matrix.org channels */

<noinclude>
[[Category:Contact]][[Category:Resource]]
</noinclude>

== Matrix ==
Some Sugar Labs chat takes place on Matrix (see [[wikipedia:Matrix|Matrix Protocol]]).
* Currently, no Sugar Activity allows access to a matrix channel
* You can use a computer-based client to log in to Matrix, such as [https://element.io Element] or [https://gitlab.gnome.org/GNOME/Fractal Fractal]. This link should work for such clients: #sugar:matrix.org
* Easiest, might be this web browser-based service provided by Element through [https://matrix.to/#/#sugar:matrix.org chat on #sugar:matrix.org now].

Matrix is designed for group communication in discussion 'channels', but allows for personal chat and data transfer as well.
All Matrix channels at Sugar Labs are bridged to their respective IRC channels using [https://github.com/matrix-org/matrix-appservice-irc/ matrix-appservice-irc]. This bot bridges the IRC channels to Matrix and vice-versa. For your messages to be visible on the IRC side, please follow '''How to use Matrix channel''' section

The Sugar Labs Community uses a series of ''rooms'' in the '''<tt>matrix.org</tt>''' network.

==== matrix.org channels ====

{| class="wikitable sortable"
| colspan=2 style="background:lightyellow; border:1px solid black;" | '''General:'''
|Bridged to Libera IRC chat
|- valign="top"
|<tt>[https://matrix.to/#/#sugar:matrix.org #sugar]</tt> or <tt>https://matrix.to/#/#sugar:matrix.org</tt> || For day-to-day [[What is Sugar? | Sugar]] development—a casual, friendly place where Sugar developers collaborate.
|Yes
|- valign="top"
| <tt>[https://matrix.to/#/#sugar-systems:matrix.org #sugar-systems]</tt> or <tt>https://matrix.to/#/#sugar-systems:matrix.org</tt>|| A channel for discussion about Sugar Infrastructure. See the [[Infrastructure_Team | Sugar Labs Infrastructure Team]].
|Yes
|-
|<tt>[https://matrix.to/#/#music-blocks:matrix.org #music-blocks]</tt> or <tt>https://matrix.to/#/#music-blocks:matrix.org</tt>
|Share your projects and asks questions about Music Blocks
|No
|-
|<tt>[https://matrix.to/#/#musicblocksdev:matrix.org #musicblocksdev]</tt> or <tt>https://matrix.to/#/#musicblocksdev:matrix.org</tt>
|Development for Music Blocks visual programming language.
|No
|}

=== How to use Matrix channels ===
* A web-based chat for matrix channels is [http://app.element.io Element], with nickname: (whatever you like), and channel: #sugar (or whatever other channel you're trying to get into).
* Learn about Matrix / IRC etiquette. Try [http://www.ircbeginner.com/ircinfo/etiquette.html here], [http://www.livinginternet.com/r/ru_chatq.htm here], or [http://www.wxwidgets.org/wiki/index.php/IRC_Etiquette here].
* For Matrix under sugar, install the latest '''[[Activities/Browse|Browse activity]]''' and navigate to https://app.element.io.
* In a traditional Matrix client, you join a channel with the /join command, for example, enter <code>/join #sugar:matrix.org</code> in the input box.
* Connect to one of the above channels, and say hello. You will see a list of the handles (on-line names) of the people in the channel, and the conversation will appear in a scrolling window. Type your message in the command entry area, and press return.
* Contact [[User:Srevin03 | me]] for more information regarding matrix bridges.

Internet Relay Chat

2021-05-28T08:42:12Z

Srevin03: Update wiki for freenode.net deprecation. Move to libera.chat

<noinclude>
[[Category:Contact]][[Category:Resource]]
</noinclude>

== IRC, [[Internet Relay Chat]] ==
Sugar Labs no longer uses IRC as the primary mode of communication. [[Matrix]] is the preferred mode of communication. Nevertheless, the matrix and IRC channels are bridged using [https://github.com/matrix-org/matrix-appservice-irc Matrix Appservice IRC]. IRC channel only exists for backward compatibility.
* The [[Activities/IRC|'''IRC activity''']] allows access to IRC from within the Sugar environment.
* You can use a computer-based client to log in to IRC, such as [http://www.pidgin.im/ Pidgin] or [[wikipedia:X-Chat|X-Chat]]. This link should work for such clients: irc://irc.libera.chat#sugar
* Or, use a browser add-on, such as [https://chrome.google.com/webstore/detail/circ/bebigdkelppomhhjaaianniiifjbgocn?hl=en-US CIRC] (for Chrome). Current versions of Firefox are no longer compatible with add-ons, so ChatZilla will only work if you are using a sufficiently older version of Firefox.

IRC is mainly designed for group communication in discussion 'channels', but allows for personal chat and data transfer as well.

Sugar Labs is moving sugar channels from Freenode.net to Libera.chat.

The Sugar Labs Community uses a series of ''channels'' in the '''<tt>irc.libera.chat</tt>''' network.

==== IRC channel discussion archives ====

* Archives of many Sugar-related IRC channels are generated automatically by an IRC bot and are indexed [http://meeting.sugarlabs.org/ here].

----

==== irc.freenode.net channels ====


{|
| colspan=2 style="background:lightyellow; border:1px solid black;" | '''General:'''
|- valign="top"
|<tt>[http://webchat.freenode.net/?randomnick=1&channels=sugar&prompt=1 #sugar]</tt> or <tt>irc://irc.libera.chat#sugar</tt> || For day-to-day [[What is Sugar? | Sugar]] development—a casual, friendly place where Sugar developers collaborate.
|- valign="top"
| <tt>[http://webchat.freenode.net/?randomnick=1&channels=sugar-meeting&prompt=1 #sugar-meeting]</tt> or <tt>irc://irc.libera.chat#sugar-meeting</tt>|| A channel for scheduled Sugar Labs meetings. See the [[Sugar Labs/Events | Sugar Labs event calendar]]. (not active, Meetings now happen on [[Matrix]]
|- valign="top"
| <tt>[http://webchat.freenode.net/?randomnick=1&channels=fedora-olpc&prompt=1 #fedora-olpc]</tt> or <tt>irc://irc.freenode.net#fedora-olpc</tt> || A channel for the Fedora development project for OLPC XOs and a Sugar distribution. See the [http://fedoraproject.org/wiki/OLPC project page].

|}

==== irc.oftc.net channels ====
{|
|-
| colspan=2 style="background:lightyellow; border:1px solid black;" | '''General:'''
|- valign="top"
|- valign="top"
| <tt>[http://embed.mibbit.com/?server=irc.oftc.net&channel=%23schoolserver&noServerTab=false #schoolserver]</tt> or <tt>irc://irc.oftc.net#schoolserver</tt> || The meeting channel for the XS, the '''X'''O school '''S'''erver. (Not active in September 2009.)
|- valign="top"
| <tt>[http://embed.mibbit.com/?server=irc.oftc.net&channel=%23treehouse&noServerTab=false #treehouse]</tt> or <tt>irc://irc.oftc.net#treehouse</tt> || The meeting channel for the [http://monitoring.treehouse.su/munin/DOMs/comparison-day.html#virtual%20machines Treehouse] - Hosting
|}

* See also [[OLPC:Communication channels]].

=== How to use IRC channels ===
* A web-based chat for other channels is [http://www.mibbit.com Mibbit], with nickname: (whatever you like), server: irc.oftc.net, and channel: #schoolserver (or whatever other channel you're trying to get into). It also includes an in-line '''translation''' service that is helpful when other languages are used.
* Some helpful resources are [http://www.mirc.com/irc.html here], and [http://www.irchelp.org/irchelp/irctutorial.html this tutorial], which also includes basic commands.
* Learn about IRC etiquette. Try [http://www.ircbeginner.com/ircinfo/etiquette.html here], [http://www.livinginternet.com/r/ru_chatq.htm here], or [http://www.wxwidgets.org/wiki/index.php/IRC_Etiquette here].
* For IRC under sugar, install the latest '''[[Activities/IRC|Sugar IRC activity]]'''.
* In Pidgin you can configure IRC and then Add a Chat to your Buddy list. Select the IRC channel from the drop-down menu, and enter the name of the channel. You can set Pidgin to open channels automatically whenever it starts up.
* In a traditional IRC client, you join a channel with the /join command, for example, enter <code>/join #sugar</code> in the input box.
* Connect to one of the above channels, and say hello. You will see a list of the handles (on-line names) of the people in the channel, and the conversation will appear in a scrolling window. Type your message in the command entry area, and press return.
* Instructions for using the meeting log robot are [[OLPC:User:Dogi/meeting | here]].

Service/activities4

2021-01-21T06:05:14Z

Srevin03:

== Description ==
A redesigned Sugar Activity Library for Python3 Activities.

== Hostnames ==

* http://v4.activities.sugarlabs.org/

== Hosted on ==

* [[Machine/sunjammer]]

== Administrative contact ==

activities AT sugarlabs DOT org

== Sysadmins ==

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

* [[User:Srevin03|Srevin Saju]], maintainer.

== Notes ==

To add your activity bundle to {{ code | aslo-v4 }}, you need to be a member of the {{ code | sugardl }} group.
Then, copy your bundle to {{ code | /srv/activities-v4/bundles }}, for example:

rsync dist/Pippy-17.xo user@sunjammer.sugarlabs.org:/srv/activities-v4/bundles/

# optionally, generate the metadata and copy them to the same bundles directory

# add a link to source code repository
git config --get remote.origin.url > org.laptop.Pippy.git

# get a list of authors of the activity
git -P --log --pretty=format:"%an" > org.laptop.Pippy.log

# copy it to sunjammer's bundles/metadata directory
rsync org.laptop.Pippy.* user@sunjammer.sugarlabs.org:/srv/activities-v4/bundles/metadata/

# trigger a new build of aslo-v4
rebuild-aslo

Deploy directory: {{ code | /srv/www-sugarlabs/v4-activities }}
Source directory: {{ code | /srv/activities-v4/src }}
Bundle (*.xo) directory: {{ code | /srv/activities-v4/bundles }}

== Upgrade notes ==

As '''activities-v4''' user on [[Machine/sunjammer]], do

~/bin/also-refresh-src
~/bin/aslo-rebuild

This will pull {{ code | master }} from the [https://github.com/sugarlabs/aslo-v4 source repository], and the python library will be installed to {{ code | ~/.local/lib/python3.x/site-packages }}. Once this has been done, it will be accessible from any directory. {{ code | ~/bin/aslo-rebuild }} will rebuild v4.activities.sugarlabs.org, and deploy it to {{ code | /srv/www-sugarlabs/v4-activities }}. This is only recommended if the user is '''activities-v4'''. For all other cases, please use {{ code | rebuild-aslo -> /usr/local/bin/rebuild-aslo }} and {{ code | source-update-aslo -> /usr/local/bin/source-update-aslo }} for rebuilding and updating the source code.

ASLO-v4 also maintains host specific configuration in {{ code | /srv/activities-v4/etc }} which is maintained in a git repository. To make changes, add yourself to the {{ code | activities-v4 }} group and commit your changes.

== Sources ==

* [https://github.com/sugarlabs/aslo-v4 source repository].

Service/activities4

2021-01-20T06:48:44Z

Srevin03: add more documentation

== Description ==
A redesigned Sugar Activity Library for Python3 Activities.

== Hostnames ==

* http://v4.activities.sugarlabs.org/

== Hosted on ==

* [[Machine/sunjammer]]

== Administrative contact ==

activities AT sugarlabs DOT org

== Sysadmins ==

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

* [[User:Srevin03|Srevin Saju]], maintainer.

== Notes ==

To add your activity bundle to {{ code | aslo-v4 }}, you need to be a member of the {{ code | sugardl }} group.
Then, copy your bundle to {{ code | /srv/activities-v4/bundles }}, for example:

rsync dist/Pippy-17.xo user@sunjammer.sugarlabs.org:/srv/activities-v4/bundles/

# optionally, generate the metadata and copy them to the same bundles directory

# add a link to source code repository
git config --get remote.origin.url > org.laptop.Pippy.git

# get a list of authors of the activity
git -P --log --pretty=format:"%an" > org.laptop.Pippy.log

# copy it to sunjammer's bundles/metadata directory
rsync org.laptop.Pippy.* user@sunjammer.sugarlabs.org:/srv/activities-v4/bundles/metadata/

A cron job will automatically rebuild the aslo-v4 and deploy it. Verify that your changes are deployed within 12 hours.
'''TODO: ''', use a better tool to rebuild the source on detecting changes.

Deploy directory: {{ code | /srv/www-sugarlabs/v4-activities }}
Source directory: {{ code | /srv/activities-v4/src }}
Bundle (*.xo) directory: {{ code | /srv/activities-v4/bundles }}

== Upgrade notes ==

As '''activities-v4''' user on [[Machine/sunjammer]], do

~/bin/also-refresh-src
~/bin/aslo-rebuild

This will pull {{ code | master }} from the [https://github.com/sugarlabs/aslo-v4 source repository], and the python library will be installed to {{ code | ~/.local/lib/python3.x/site-packages }}. Once this has been done, it will be accessible from any directory. {{ code | ~/bin/aslo-rebuild }} will rebuild v4.activities.sugarlabs.org, and deploy it to {{ code | /srv/www-sugarlabs/v4-activities }}.

== Sources ==

* [https://github.com/sugarlabs/aslo-v4 source repository].

2020-11-16T14:33:56Z

Srevin03: change vba to vda

Machine/template-focal

2020-11-16T14:14:36Z

Srevin03: /* Partitioning */

Machine/template-focal

2020-11-16T14:13:54Z

Srevin03: /* VM Creation (host part) */

Machine/template-focal

2020-11-16T14:00:38Z

Srevin03: /* VM Creation (host part) */

2019-12-27T15:36:24Z

Srevin03:

File:Mb4.png

2019-12-27T15:36:04Z

Srevin03:

File:Mb2.png

2019-12-27T15:35:39Z

Srevin03:

File:Mb01.png

2019-12-27T15:35:17Z

Srevin03:

Getting Started

2019-12-27T15:32:00Z

Srevin03:

<noinclude>{{note/help|Please help us improve this page.|[[{{TALKPAGENAMEE}}#Improve the Getting Started page|Tell us how it could be improved]].}}
{{Translations
|[[Getting Started|english]] | [[Getting Started/lang-de|deutsch]] | [[Getting Started/lang-es|español]] | [[Getting Started/lang-fr|français]] | [[Getting Started/lang-pt|português]] }}</noinclude>

<center>[[File:Sugar-small.png]]</center>

<center><big><big><big>The Constructionist Learning Environment</big></big></big></center>

== About Sugar ==

Sugar is a constructionist learning desktop environment that is an alternative to the ones typically used in Microsoft Windows, Apple's OS X or other GNU/Linux operating systems. It is conceived as a platform upon which children learn with Sugar [[Activities]]. The platform provides mechanisms for [[Collaboration|collaboration]], [[Activities/Portfolio|reflection]], and [[View Source|exploration]]. Sugar Activities cover a broad range of applications: browsing, drawing, composing, writing, programming, etc. See this [http://www.sugarlabs.org/index.php?template=gallery&page=gallery gallery of screenshots].

<gallery mode="slideshow">
File:Sugarlabs-home-view.png | Sugar Desktop
File:Musicblocks_1.png | MusicBlocks - A sugar Activity
File:Neighborhood_sugarlabs.png | Collaboration on Sugar
</gallery>

[[Tutorials/Introduction to the Sugar Interface|Introduction to the Sugar Interface]] describes multiple full-screen views: a Home view, from which Activities are launched; a Neighborhood view, where learners can connect to each other through a [[olpc:Community Jabber Servers|Jabber network]]; a Journal view, which can be used as a ''lab notebook''; and the Activity view, where Sugar Activities are run.

Sugar Activities have no Save menu: everything is saved automatically. While the interface uses very little text, additional information is revealed when the user hovers over icons.

Sugar is Free Software. It is developed in [[wikipedia:Python_%28programming_language%29|Python]] and runs on a [[wikipedia:Linux|GNU/Linux]] [[wikipedia:Kernel_%28computer_science%29|Kernel]], originally from the [http://fedoraproject.org/ Fedora Project], and now from a [[Supported distributions|variety of GNU/Linux distributions]].

For an overview of the components composing a Sugar system see the [[Sugar System Stack]].

'''Developers''': Those interested in developing Sugar software should visit our [http://developer.sugarlabs.org/ developer documentation website].

==Getting Sugar==

<center> <big><big>Where do you want to install sugar? </big></big> </center>

<center>(Jump directly to installation, or read through for step-by-step instruction).</center>
<center> '''Quick Links : ''' [[#Hardware requirements]], [[#Sugar Live CD]], [[#Sugar on a Stick]], [[#Sugar on a Virtual_Machine]] </center>

<center><gallery>
File:Fedora_flat.png|link=Installation#Fedora
File:Ubuntu_flat.png|link=Installation#Ubuntu
File:Debian_logo.png|link=Installation#Debian
File:Arch-linux-logo.png|link=Installation#Arch_Linux
File:Windows_new.png|link=Installation#Windows
File:Apple_flat.png|link=Installation#Mac_OS
File:Rpi_logo.png|link=Installation#Raspberry_Pi
</gallery></center>
<center>Or scroll down to explore more on the various possibilities of Sugar OS !</center>

This section aims to be an introductory walkthrough of some of the methods of installing Sugar covered on the pages [[Sugar on a Stick/Installation]] and [[Supported systems]].

===Hardware requirements===

* 1 GHz or faster processor
* 64-bit Processor
* 1 GB System Memory (RAM)
* The Sugar .iso file from [[Sugar on a Stick/Downloads]]
* 1 GB USB Drive (2 GB Recommended) or a Compact Disk (any)
* A compatible USB or CD port (any)
* USB Boot allowed on the BIOS (older PCs)

If your system requirements fall below those mentioned here, or you would like to check for alternatives, see [[Hardware_Requirements | Detailed Hardware Requirements]]

== Installing Sugar ==
Sugar can be installed as an Operating System installed on a Hard Drive, Live CD, or a USB Drive. Alternatively it supports almost all Debian-based and RHEL based Linux Operating Systems, and can be natively installed as a Desktop Environment.
See any of the OSes in [[#Getting Sugar]].

===Sugar Live CD===

The Sugar LiveCD contains a complete, functioning Sugar distribution and operating system on CD.

The Sugar LiveCD does not alter files already installed on your computer. It returns to its previous state when the LiveCD is ejected and the computer is rebooted. The Sugar LiveCD allows you to temporarily run Sugar; this allows you to explore Sugar and test how Sugar runs on your hardware. Your settings will not be saved between boots, but you can experiment with inserting a USB stick into the computer running the LiveCD, and reading from, and saving work to, the USB stick.

Produce your LiveCD by downloading the Sugar on a Stick .iso image from [[Sugar on a Stick/Downloads]] and burning it onto a blank CD.

Many computers have built in software which will convert and copy, "burn", an .iso image to a blank CD. In Windows 8 from the File Manager, right click the .iso file and select 'Burn disc image' from the context menu, or use a free utility, like [http://www.imgburn.com/ ImgBurn].

To run Sugar, insert your LiveCD into your computer and reboot into Sugar.

===Sugar on a Stick===
Sugar on a Stick (aka SOAS) is the USB implementation of Sugar for its portability and efficiency. There are many methods to create a SOAS. The downloaded sugar .iso from [[Sugar on a Stick/Downloads]] is then flashed (a bootable copying process) to a USB. For people who like GUI, there are Fedora Media Writer (Linux/Windows), UNetBootin (Linux, Mac, Windows), Rufus (Windows), etc. For command line interfaces, see ''livecd-iso-to-disk'' on [[Sugar on a Stick/Installation]]

===Sugar on a Virtual Machine===

The advantage of a Virtual Machine (VM) is that, with the full VM documentation provided online, you follow that documentation to install the VM on your PC or Mac. VirtualBox® is a suitable choice of VM for a first attempt, see their website: https://www.virtualbox.org/

As ever, download the Sugar on a Stick .iso from [[Sugar on a Stick/Downloads]]

Open the VM, bind the .iso image to the VM and boot it.

All VMs have excellent documentation on how to boot an .iso and again it is covered on this page [[Sugar on a Stick/Installation#SoaS on VirtualBox]] and the method to make a Sugar on a Stick from your VM, is covered here [[Sugar on a Stick/Installation#with Microsoft Windows]] in Method 3, Launch a virtual machine with the Sugar on a Stick .iso file, then run the script, livecd-iso-to-disk

== Sugarizer ==
Sugarizer is a free/libre learning platform. The Sugarizer UI use ergonomic principles from The Sugar platform, developed for the One Laptop per Child project and used every day by more than 2 million children around the world.

Sugarizer runs on every device: from Raspberry Pi computers to Android and iOS phones to tablets and to laptops and desktops.

Sugarizer includes a bunch of pedagogic activities thought for children, see here for more.

Sugarizer is available as:

Application: an installable app for every operating system
Web Application: a web application that runs in modern web browsers

Sugarizer is not a fork of sugar. To know more or to sugarizer, click [[https://github.com/llaske/sugarizer#what-is-sugarizer- here]]
Or try me now here [[http://try.sugarizer.org/]]

== Please Explore Sugar ==
:'''and take it out into your community'''

There are two further pages in the Getting Started set.
: Once you are able to launch Sugar, see [[Getting Started/Explore]].
::If you can take Sugar out into your school or community, see [[Getting Started/Presentation]] for ideas on how to demonstrate it to others.

== I need more information ==

See https://help.sugarlabs.org, the Activity Help provided online.

The Sugar Labs wiki is a collaboration site for [[Sugar Labs]] teams, the [[Sugar on a Stick]] project alone comprises over 75 pages or sub-pages. For an overview of the developing SoaS see [[Sugar on a Stick/Project sitemap]].

Find The Sugar Learning Platform Homepage at http://www.sugarlabs.org/.

==Release notes==

Release notes for '''Sugar {{Current Stable Release}}''' are available [[{{Current Stable Release}}/Notes|here]].

{{Template:Platform Cycle Linkbar}}

[[Category:Help]]
[[Category:HowTo]]
[[Category:Getting started]]

File:Sugar-small.png

2019-12-27T15:26:15Z

Srevin03:

Getting Started

2019-12-24T11:26:23Z

Srevin03:

<noinclude>{{note/help|Please help us improve this page.|[[{{TALKPAGENAMEE}}#Improve the Getting Started page|Tell us how it could be improved]].}}
{{Translations
|[[Getting Started|english]] | [[Getting Started/lang-de|deutsch]] | [[Getting Started/lang-es|español]] | [[Getting Started/lang-fr|français]] | [[Getting Started/lang-pt|português]] }}</noinclude>

<center>[[File:Logo alt 3.png]]</center>

<center><big><big><big>The Constructionist Learning Environment</big></big></big></center>

== About Sugar ==

Sugar is a constructionist learning desktop environment that is an alternative to the ones typically used in Microsoft Windows, Apple's OS X or other GNU/Linux operating systems. It is conceived as a platform upon which children learn with Sugar [[Activities]]. The platform provides mechanisms for [[Collaboration|collaboration]], [[Activities/Portfolio|reflection]], and [[View Source|exploration]]. Sugar Activities cover a broad range of applications: browsing, drawing, composing, writing, programming, etc. See this [http://www.sugarlabs.org/index.php?template=gallery&page=gallery gallery of screenshots].

<gallery mode="slideshow">
File:Sugarlabs-home-view.png | Sugar Desktop
File:Musicblocks_1.png | MusicBlocks - A sugar Activity
File:Neighborhood_sugarlabs.png | Collaboration on Sugar
</gallery>

[[Tutorials/Introduction to the Sugar Interface|Introduction to the Sugar Interface]] describes multiple full-screen views: a Home view, from which Activities are launched; a Neighborhood view, where learners can connect to each other through a [[olpc:Community Jabber Servers|Jabber network]]; a Journal view, which can be used as a ''lab notebook''; and the Activity view, where Sugar Activities are run.

Sugar Activities have no Save menu: everything is saved automatically. While the interface uses very little text, additional information is revealed when the user hovers over icons.

Sugar is Free Software. It is developed in [[wikipedia:Python_%28programming_language%29|Python]] and runs on a [[wikipedia:Linux|GNU/Linux]] [[wikipedia:Kernel_%28computer_science%29|Kernel]], originally from the [http://fedoraproject.org/ Fedora Project], and now from a [[Supported distributions|variety of GNU/Linux distributions]].

For an overview of the components composing a Sugar system see the [[Sugar System Stack]].

'''Developers''': Those interested in developing Sugar software should visit our [http://developer.sugarlabs.org/ developer documentation website].

==Getting Sugar==

<center> <big><big>Where do you want to install sugar? </big></big> </center>

<center>(Jump directly to installation, or read through for step-by-step instruction).</center>
<center> '''Quick Links : ''' [[#Hardware requirements]], [[#Sugar Live CD]], [[#Sugar on a Stick]], [[#Sugar on a Virtual_Machine]] </center>

<center><gallery>
File:Fedora_flat.png|link=Installation#Fedora
File:Ubuntu_flat.png|link=Installation#Ubuntu
File:Debian_logo.png|link=Installation#Debian
File:Arch-linux-logo.png|link=Installation#Arch_Linux
File:Windows_new.png|link=Installation#Windows
File:Apple_flat.png|link=Installation#Mac_OS
File:Rpi_logo.png|link=Installation#Raspberry_Pi
</gallery></center>
<center>Or scroll down to explore more on the various possibilities of Sugar OS !</center>

This section aims to be an introductory walkthrough of some of the methods of installing Sugar covered on the pages [[Sugar on a Stick/Installation]] and [[Supported systems]].

===Hardware requirements===

* 1 GHz or faster processor
* 64-bit Processor
* 1 GB System Memory (RAM)
* The Sugar .iso file from [[Sugar on a Stick/Downloads]]
* 1 GB USB Drive (2 GB Recommended) or a Compact Disk (any)
* A compatible USB or CD port (any)
* USB Boot allowed on the BIOS (older PCs)

If your system requirements fall below those mentioned here, or you would like to check for alternatives, see [[Hardware_Requirements | Detailed Hardware Requirements]]

== Installing Sugar ==
Sugar can be installed as an Operating System installed on a Hard Drive, Live CD, or a USB Drive. Alternatively it supports almost all Debian-based and RHEL based Linux Operating Systems, and can be natively installed as a Desktop Environment.
See any of the OSes in [[#Getting Sugar]].

===Sugar Live CD===

The Sugar LiveCD contains a complete, functioning Sugar distribution and operating system on CD.

The Sugar LiveCD does not alter files already installed on your computer. It returns to its previous state when the LiveCD is ejected and the computer is rebooted. The Sugar LiveCD allows you to temporarily run Sugar; this allows you to explore Sugar and test how Sugar runs on your hardware. Your settings will not be saved between boots, but you can experiment with inserting a USB stick into the computer running the LiveCD, and reading from, and saving work to, the USB stick.

Produce your LiveCD by downloading the Sugar on a Stick .iso image from [[Sugar on a Stick/Downloads]] and burning it onto a blank CD.

Many computers have built in software which will convert and copy, "burn", an .iso image to a blank CD. In Windows 8 from the File Manager, right click the .iso file and select 'Burn disc image' from the context menu, or use a free utility, like [http://www.imgburn.com/ ImgBurn].

To run Sugar, insert your LiveCD into your computer and reboot into Sugar.

===Sugar on a Stick===
Sugar on a Stick (aka SOAS) is the USB implementation of Sugar for its portability and efficiency. There are many methods to create a SOAS. The downloaded sugar .iso from [[Sugar on a Stick/Downloads]] is then flashed (a bootable copying process) to a USB. For people who like GUI, there are Fedora Media Writer (Linux/Windows), UNetBootin (Linux, Mac, Windows), Rufus (Windows), etc. For command line interfaces, see ''livecd-iso-to-disk'' on [[Sugar on a Stick/Installation]]

===Sugar on a Virtual Machine===

The advantage of a Virtual Machine (VM) is that, with the full VM documentation provided online, you follow that documentation to install the VM on your PC or Mac. VirtualBox® is a suitable choice of VM for a first attempt, see their website: https://www.virtualbox.org/

As ever, download the Sugar on a Stick .iso from [[Sugar on a Stick/Downloads]]

Open the VM, bind the .iso image to the VM and boot it.

All VMs have excellent documentation on how to boot an .iso and again it is covered on this page [[Sugar on a Stick/Installation#SoaS on VirtualBox]] and the method to make a Sugar on a Stick from your VM, is covered here [[Sugar on a Stick/Installation#with Microsoft Windows]] in Method 3, Launch a virtual machine with the Sugar on a Stick .iso file, then run the script, livecd-iso-to-disk

== Please Explore Sugar ==
:'''and take it out into your community'''

There are two further pages in the Getting Started set.
: Once you are able to launch Sugar, see [[Getting Started/Explore]].
::If you can take Sugar out into your school or community, see [[Getting Started/Presentation]] for ideas on how to demonstrate it to others.

== I need more information ==

See https://help.sugarlabs.org, the Activity Help provided online.

The Sugar Labs wiki is a collaboration site for [[Sugar Labs]] teams, the [[Sugar on a Stick]] project alone comprises over 75 pages or sub-pages. For an overview of the developing SoaS see [[Sugar on a Stick/Project sitemap]].

Find The Sugar Learning Platform Homepage at http://www.sugarlabs.org/.

==Release notes==

Release notes for '''Sugar {{Current Stable Release}}''' are available [[{{Current Stable Release}}/Notes|here]].

{{Template:Platform Cycle Linkbar}}

[[Category:Help]]
[[Category:HowTo]]
[[Category:Getting started]]