Line 5: |
Line 5: |
| == Zero Sugar Distribution == | | == Zero Sugar Distribution == |
| | | |
− | Zero Sugar provides a method that is transparent for users and convenient for doers to deploy software across varying platforms as well as across Sugar releases. Zero Sugar is mainly targeted to support a direct doer-to-user interaction model, i.e., shortcut the chain of transfer of doer-to-distributor-to-user (still, Zero Sugar could be [[#Distributors|beneficial]] for distributors, since it unifies the deployment workflow). | + | Zero Sugar provides a method that is transparent for users and convenient for doers to deploy software across varying platforms as well as across Sugar releases. Zero Sugar is mainly targeted to support a direct, doer-to-user interaction model, i.e., shortcut the chain of transfer of doer-to-distributor-to-user (still, Zero Sugar could be [[#Distributors|beneficial]] for distributors, since it unifies the deployment workflow). |
| | | |
| == Benefits == | | == Benefits == |
| | | |
− | How Zero Sugar might be useful depending upon your point of view. | + | How Zero Sugar might be useful depending upon your point of view: |
| | | |
| See also [[Activity_Team/Zero_Sugar/Use_Cases|other]] use cases. | | See also [[Activity_Team/Zero_Sugar/Use_Cases|other]] use cases. |
Line 49: |
Line 49: |
| * how to share the code. | | * how to share the code. |
| | | |
− | Zero Sugar spec file is an all-sufficient entity. Having only spec file and tools like {{Code|0sugar}} and {{Code|0distro}}, it is possible to prepare the code to launch in various environments like major rpm/deb based GNU/Linux distributions or just local launch. | + | The Zero Sugar spec file is an all-sufficient entity. With only the spec file and tools like {{Code|0sugar}} and {{Code|0distro}}, it is possible to prepare the code necessary to launch in various environments like the major rpm/deb-based GNU/Linux distributions or just launch locally. |
| | | |
| === Prepare the code === | | === Prepare the code === |
| | | |
− | A preparation step might be not trivial only if code requires building stage. Building might occur:
| + | The preparation step can be trivial, unless the code requires a building stage. Building might occur: |
| * on the developer's workstation, to deploy to environments similar to the developer's, | | * on the developer's workstation, to deploy to environments similar to the developer's, |
| * on OBS, to build for the GNU/Linux distributions that OBS supports, or | | * on OBS, to build for the GNU/Linux distributions that OBS supports, or |
− | * building might happen on user's side if other methods don't work. | + | * building might happen on the user's side, if other methods don't work. |
| | | |
| === Share the code === | | === Share the code === |
| | | |
| Sharing step might be: | | Sharing step might be: |
− | * ''local'', if code needs to be run only in doer's environment.<br>Zero Sugar spec file will be handled as regular {{Code|activity.info}} file. | + | * ''local'', if code needs to be run only in the doer's environment.<br>Zero Sugar spec file will be handled as a regular {{Code|activity.info}} file. |
| * ''peer-to-peer'', direct sharing between doer and users. | | * ''peer-to-peer'', direct sharing between doer and users. |
− | ** Code can be launched if one of on-line users in Neighborhood View has a copy of shared code i.e. doer only needs to be on-line to let other people launch his code. | + | ** Code can be launched if on-line users in the Neighborhood View have a copy of shared code, i.e., the doer only needs to be on-line to let other people launch his code. |
− | ** Just by transfering a bundle with the code e.g. using .xo bundles. | + | ** Just by transfering a bundle with the code, e.g., using .xo bundles. |
− | * ''client-server'', doer needs to upload code to the server and users will download it.<br>Particular method might be different: | + | * ''client-server'', doer needs to upload code to the server, and users will download it.<br>The particular method might be different: |
| ** via the 0install infrastructure, | | ** via the 0install infrastructure, |
| ** via OBS repositories with native packages, | | ** via OBS repositories with native packages, |
| ** by uploading bundles to servers like ASLO. | | ** by uploading bundles to servers like ASLO. |
− | * ''distributor'', most likely similar to ''client-server'' but different from doer's point of view since only distributor is responsible for particular distribution method. | + | * ''distributor'', most likely similar to ''client-server'', but different from the doer's point of view, since only the distributor is responsible for a particular distribution method. |
| | | |
| === Regular workflow === | | === Regular workflow === |
| | | |
− | The regular workflow within Zero Sugar will look like in case of coding an python-based activity: | + | The regular workflow within Zero Sugar, in the case of coding a Python-based activity, will look like the following: |
| | | |
| * Create activity [[Activity_Team/Zero_Sugar/0sugar.info_Specification#Python_activity|spec file]]. | | * Create activity [[Activity_Team/Zero_Sugar/0sugar.info_Specification#Python_activity|spec file]]. |
| * Code the activity. | | * Code the activity. |
− | * Try current code in sugar just by selecting an icon in activities list. | + | * Try current code in Sugar just by selecting an icon in the activities list. |
− | * When milestone achieved, call: | + | * When a milestone is achieved, call: |
| ** {{Code|0sugar dist}} to create sources tarball | | ** {{Code|0sugar dist}} to create sources tarball |
− | ** {{Code|0sugar commit}} to let sugar know that activity could be shared in peer-to-peer mode between on-line users | + | ** {{Code|0sugar commit}} to let Sugar know that the activity can be shared in peer-to-peer mode between on-line users |
− | * If doer wants to support server-client sharing model for broad users audience: | + | * If doer wants to support server-client sharing model for a broad audience of users: |
− | ** request for bash login on sunjammer.sugarlabs.org (or use other servers to rsync files to), | + | ** [[Sysadmin/Shell_account_request|request an account]] on sunjammer.sugarlabs.org (or use other servers to rsync files to), |
| ** call, {{Code|0sugar push}} to publish 0install feeds and files | | ** call, {{Code|0sugar push}} to publish 0install feeds and files |
| * If doer wants to support OBS based sugar distributions or users that prefer activities from native packages: | | * If doer wants to support OBS based sugar distributions or users that prefer activities from native packages: |
Line 88: |
Line 88: |
| ** call {{Code|0sugar push <obs-project>}} | | ** call {{Code|0sugar push <obs-project>}} |
| * options for distributors: | | * options for distributors: |
− | ** If it is OBS based distribution, there is no need in any packaging related work at all, just link/branch activity to your distribution project. | + | ** If it is an OBS-based distribution, there is no need for any packaging-related work at all, just link/branch the activity to your distribution project. |
− | ** Reuse activity spec file to build native packages on non-OBS build farms. Most likely resulted packages will not conform all requirements for inclusion to official repository but could be useful when strong packaging rules are not required e.g. in various sugar/edu derivates like SoaS or USR. | + | ** Reuse the activity spec file to build native packages on non-OBS build farms. Most likely, the resulting packages will not conform to all the requirements for inclusion in an official repository, but this feature could still be useful when strong packaging rules are not required, e.g., in various Sugar/edu derivates like SoaS or USR. |
− | ** Using sources tarball generated by {{Code|0sugar dist}} command and information about dependencies from spec file, create regular package for particular GNU/Linux distribution. | + | ** Using the sources tarball generated by the {{Code|0sugar dist}} command, and information about dependencies from the spec file, create a regular package for any particular GNU/Linux distribution. |
| | | |
| == Documentation == | | == Documentation == |
| | | |
− | Start your exploration beginning with these resources: | + | Start your exploration of Zero Sugar beginning with these resources: |
| | | |
− | * How Zero Sugar looks from GNU/Linux distribution packaging point of view | + | * How Zero Sugar looks from the GNU/Linux distribution packaging point of view |
− | * How Zero Sugar looks from 0install point of view | + | * How Zero Sugar looks from the 0install point of view |
− | * How Zero Sugar looks from sugar activity developer point of view | + | * How Zero Sugar looks from the Sugar Activity developer point of view |
| | | |
− | Also also Zero Sugar example [[Activity Team/Zero Sugar/Use Cases|use cases]] .
| + | See also the Zero Sugar example [[Activity Team/Zero Sugar/Use Cases|use cases]] . |
| | | |
| <!-- | | <!-- |
| * [[Documentation Team/Services/Activity Developers Guide|Activity Developers Guide]] to get instructions on how to use the existing Zero Sugar packages in activities. | | * [[Documentation Team/Services/Activity Developers Guide|Activity Developers Guide]] to get instructions on how to use the existing Zero Sugar packages in activities. |
| * [[Documentation Team/Services/Service Developers Guide|Service Developers Guide]] for how to create a Zero Sugar package.--> | | * [[Documentation Team/Services/Service Developers Guide|Service Developers Guide]] for how to create a Zero Sugar package.--> |