Changes

no edit summary
Line 15: Line 15:  
|- valign="top" align="let"
 
|- valign="top" align="let"
 
| [[File:Sugar-network.png]]
 
| [[File:Sugar-network.png]]
| Where:
+
| Where,
 
* '''Server'''<br>is shared data and services, in general. It might be a server accessible from the Internet (on-line case) or various distributed servers located, e.g., in schools (off-line case). See [[Platform_Team/Sugar_Network|technical pages]] for more details.
 
* '''Server'''<br>is shared data and services, in general. It might be a server accessible from the Internet (on-line case) or various distributed servers located, e.g., in schools (off-line case). See [[Platform_Team/Sugar_Network|technical pages]] for more details.
 
* '''Conceptual level logic'''<br>The design logic and software code structures that reify the Sugar Network concepts. From a conceptual level, these designs and code standards represent a separate entity that operates inbetween the Clients and Servers. From the technical perspective, this level is represented by the Server [[Platform_Team/Sugar_Network/API|application programming interface (API)]] and [[Platform_Team/Sugar_Network/Objects_model|objects model]] in particular.
 
* '''Conceptual level logic'''<br>The design logic and software code structures that reify the Sugar Network concepts. From a conceptual level, these designs and code standards represent a separate entity that operates inbetween the Clients and Servers. From the technical perspective, this level is represented by the Server [[Platform_Team/Sugar_Network/API|application programming interface (API)]] and [[Platform_Team/Sugar_Network/Objects_model|objects model]] in particular.
Line 34: Line 34:  
== Needs ==
 
== Needs ==
   −
The needs that Sugar Network is trying to support. They might be described by the following selection of [[Wikipedia:Fundamental_human_needs|Fundamental human needs]]:
+
The needs that the Sugar Network is trying to support. They might be described by the following selection of [[Wikipedia:Fundamental_human_needs|Fundamental human needs]]:
    
'''Identity'''
 
'''Identity'''
   −
: Each User should be able to create and manage a unique identity in the network. Every interaction of the User with the network should be accounted in the User's metrics, as eventually, this may be part of the User's dashboard. Each User may have an individual reputation, based on other Users' ratings made on his contributions.  
+
: Each User should be able to create and manage a unique identity in the network. Every interaction of the User with the network should be accounted in the User's metrics, as eventually, this may be part of the User's dashboard. Each User may have an individual reputation, based on other Users' ratings made of his contributions.  
    
'''Understanding'''
 
'''Understanding'''
Line 70: Line 70:  
== Contexts ==
 
== Contexts ==
   −
In the Sugar Network, Contexts are the classes of content or software that include with them assumptions on how they may be shared or used.  A Context describes how Users behave with Resources. A Context represents the Behavior or set of Behaviors that are supported for associated Resources.
+
In the Sugar Network, Contexts are instances of content or software that include with them assumptions on how they may be shared or used.  A Context describes how Users behave with Resources. A Context represents the Behavior or set of Behaviors that are supported for associated Resources.
    
There is a predefined general Context, the Global Context, which contains all other Contexts (according to the current [[#Network_Zoom|zoom level]]). Thus, Users can interact with all Resources accessible on this [[#Network_Zoom|zoom level]].
 
There is a predefined general Context, the Global Context, which contains all other Contexts (according to the current [[#Network_Zoom|zoom level]]). Thus, Users can interact with all Resources accessible on this [[#Network_Zoom|zoom level]].
Line 95: Line 95:  
=== Questions ===
 
=== Questions ===
   −
General question about the Context. A user-friendly interface for asking questions about the current Context. The workflow is much simpler when compared to typical bug trackers (Trac, RT, etc.).  It is intended to be more like "forums" or wiki "discussion" pages, just ask your question and wait for answers. Besides, Questions might be treated as a kind of simple [[Wikipedia:Knowledge base|knowledge base]] for the Context (in comparing with bug trackers, Questions are not being closed after getting answers). The most useful Questions might be picked up to compose the [[Wikipedia:FAQ|FAQ]] for the Context.
+
General question about the Context. A user-friendly interface for asking questions about the current Context. The workflow is much simpler when compared to typical bug trackers (Trac, RT, etc.).  It is intended to be more like "forums" or wiki "discussion" pages&mdash;just ask your question and wait for answers. In some cases, Questions might be treated as a kind of simple [[Wikipedia:Knowledge base|knowledge base]] for the Context (in contrast to bug trackers, Questions are not closed after answers are provided). The most useful Questions might be picked up to compose the [[Wikipedia:FAQ|FAQ]] for the Context.
   −
The rest of non-developers needs are covered by [[#Ideas|Ideas]] and [[#Problems|Problems]]. The developers needs are covered by the [[#Objectives|Objectives]] and its advanced view in particular.
+
Other of non-developer needs are covered by [[#Ideas|Ideas]] and [[#Problems|Problems]]. Developer needs are covered by the [[#Objectives|Objectives]] and its advanced view in particular.
    
Actions:
 
Actions:
Line 111: Line 111:  
=== Ideas ===
 
=== Ideas ===
   −
Any ideas regarding the Context. A user-friendly interface to propose your idea to the current Context developers. The workflow is much simpler, compared to typical bug trackers, just offer your suggestion, look how other people will rate it and wait for the implementation.
+
Any ideas regarding the Context. A user-friendly interface to propose your idea to the current Context developers. The workflow is much simpler, compared to typical bug trackers, just offer your suggestion, see how other people will rate it, and wait for an implementation.
 
  −
The rest of non-developers needs are covered by [[#Questions|Questions]] and [[#Problems|Problems]]. The developers needs are covered by the [[#Objectives|Objectives]] and its advanced view in particular.
      
Actions:
 
Actions:
Line 127: Line 125:  
=== Problems ===
 
=== Problems ===
   −
Report a problem with the Context. A user-friendly interface to complain about an error that the User encountered when working with the Context. The workflow is much simpler, compared to typical bugs trackers, just complain and wait for a fix.
+
Report a problem with the Context. A user-friendly interface to complain about an error that the User encountered when working with the Context. The workflow is much simpler, compared to typical bugs trackers, just complain and wait for a fix.
 
  −
The rest of non-developers needs are covered by [[#Questions|Questions]] and [[#Ideas|Ideas]]. The developers needs are covered by the [[#Objectives|Objectives]] and its advanced view in particular.
      
Actions:
 
Actions:
Line 144: Line 140:  
=== Wiki ===
 
=== Wiki ===
   −
A collection of Wiki pages that use MediaWiki markup language, wikitext. Pages might be represented by a tree of pages. There is all time the root page. The idea to have a root page is to let it possible to merge these wiki pages to the standalone MediaWiki server.
+
A collection of Wiki pages that use MediaWiki markup language, wikitext. Pages might be represented by a tree of pages. There is always a root page. The idea of having a root page is to make it possible to merge these wiki pages to the standalone MediaWiki server.
    
Actions:
 
Actions:
   −
:* Create new Wiki page in hierarchy of pages;
+
:* Create a new Wiki page in the hierarchy of pages;
:* Upload arbitrary file to place a link on it on Wiki pages.
+
:* Upload an arbitrary file in order to place a link to it on Wiki pages.
:* Discuss the Wiki;
+
:* Discuss the Wiki topic;
 
:* Vote for the Wiki;
 
:* Vote for the Wiki;
   Line 170: Line 166:  
Todo:
 
Todo:
   −
:* Simplify creating new Exhibit having a UI way to fast share just created activity object, e.g., from in Naming alert or from Journal.
+
:* Simplify creation of a new Exhibit by having a UI way to quickly share a newly created activity object, e.g., from within the Naming alert or from the Journal.
    
=== Implementation ===
 
=== Implementation ===
   −
For software Contexts, this Resource is about released versions of this Context software. This is exactly what User can execute. There might be several implementations with different stability levels. By default, Users execute only recent stable version, but it is possible to choose any version.
+
For software Contexts, this Resource is about released versions of this Context software. This is exactly what a User can execute. There might be several implementations with different stability levels. By default, Users execute only the most recent stable version, but it is possible to choose any version.
    
Actions:
 
Actions:
   −
:* Context owners can create new Implementation;
+
:* Context owners can create a new Implementation;
 
:* Launch.
 
:* Launch.
 
:* Discuss the Release;
 
:* Discuss the Release;
Line 185: Line 181:  
Todo:
 
Todo:
   −
:* Support Experiments workflow when people can make a copy of existing Context and start experimenting with the code and use on regular basis, e.g., share with the rest of Sugar Network.
+
:* Support Experiments workflow where people can make a copy of an existing Context and start experimenting with the code and use it on a regular basis, e.g., share with the rest of Sugar Network.
 
:* Convenient method to attach log reports with errors to the particular Release, e.g., "Share the log" button on activity fail dialog.
 
:* Convenient method to attach log reports with errors to the particular Release, e.g., "Share the log" button on activity fail dialog.
    
=== Objectives ===
 
=== Objectives ===
   −
These are the exactly objectives that Context is trying to achieve. This type of Resources has two faces:
+
These are the exact objectives that a Context is trying to achieve. This type of Resources has two faces:
   −
* The view for Users that are not the part of Context implementers, they see this Resource as a list of, e.g., features that Context is trying to provide;
+
* The view for Users that are not the part of Context implementers, they see this Resource as a list of, e.g., features that the Context is trying to provide;
* The full functional project management interface for people who are owners of the Context and take care of implementation.
+
* The fully functional project management interface for people who are owners of the Context and take care of its implementation.
    
Actions:
 
Actions:
Line 207: Line 203:  
== Comments ==
 
== Comments ==
   −
All kinds of resources might be [[#Participation|commented by any users]]. The Sugar Network does not provide any restrictions or permissions, the model is [[#Freedom|leaving responsibility to a viewer]].
+
All kinds of resources might be [[#Participation|commented on by any users]]. The Sugar Network does not provide any restrictions or permissions, the model is [[#Freedom|leaving responsibility to a viewer]].
    
== Events ==
 
== Events ==
   −
If some Resource has been changed, e.g., as a result of User interacting, Resource sends global notifications. These notification might be seen while investigating this particular object or by Following this Resource. In the last case, events will go to followers' queue of global events.
+
If some Resource has been changed, e.g., as a result of User interaction, the Resource sends out global notifications. The notification might be seen while investigating this particular object or by Following this Resource. In the last case, events will go to followers' queue of global events.
    
Events might be personal, e.g., personal invitations or personal messages.
 
Events might be personal, e.g., personal invitations or personal messages.
Line 218: Line 214:     
These are kinds of workflows that [[#Roles|Roles]] can take part in. The particular activity might involve several Users and several Roles.
 
These are kinds of workflows that [[#Roles|Roles]] can take part in. The particular activity might involve several Users and several Roles.
 +
 +
== Roles ==
    
=== Support ===
 
=== Support ===
   −
A need for general help from the local community supporters.
+
A need for general help from the local community of supporters.
   −
:* You need to be a part of a community with local support, thus, you will have the default place to complain, the Home Context;
+
:* You need to be a part of a community with local support, thus, you will have a default place to complain, the Home Context;
 
:* Go to Browser and click Home Context button;
 
:* Go to Browser and click Home Context button;
 
:* Try to search if your problem was already reported using text search string or tags;
 
:* Try to search if your problem was already reported using text search string or tags;
:* If search is not successful, describe your problem in Problem (as well for Questions and Ideas) entry widget as full as possible;
+
:* If search is not successful, describe your problem in Problem (as well for Questions and Ideas) entry widget as fully as possible;
:* The supporters will be notified and and will reply with request for further information or with an answer;
+
:* The supporters will be notified and will reply with a request for further information, or with an answer;
:* On the Network screen, you will be notified about gotten reply.
+
:* On the Network screen, you will be notified about a submitted reply.
   −
Something goes wrong with the system and it is not clear where the problem is.
+
Suppose something goes wrong with the system, and it is not clear where the problem is.
   −
:* You need to be a part of a community with local support, thus, you will have the default place to complain, the Home Context;
+
:* You need to be a part of a community with local support, thus, you will have a default place to complain, the Home Context;
:* Since there is no any ideas what the place in the system is affected, thus, no way to decide what Context to choose to complain, go to Browser and click Home Context button;
+
:* Since there is not any ideas about what part of the system is affected, thus, there is no way to decide against which Context to complain, go to Browser and click Home Context button;
:* Try to search if your problem was already reported using text search string or tags;
+
:* Try to search if your problem was already reported using a text search string or tags;
:* If search is not successful, describe your problem in Problem (as well for Questions and Ideas) entry widget as full as possible;
+
:* If the search is not successful, describe your problem in a Problem entry widget (as for Questions and Ideas) as fully as possible;
:* The supporters will be notified and and will reply with request for further information or with an answer;
+
:* The supporters will be notified and will reply with a request for further information, or with an answer;
:* On the Network screen, you will be notified about gotten reply.
+
:* On the Network screen, you will be notified about a submitted reply.
   −
Something goes wrong with the system and it is possible to specify the place where it happens.
+
Suppose something goes wrong with the system and it is possible to specify the part or place where it occurs.
   −
:* Go to the Browser and try to find the Context that is associated with problem place; use Tags and full text search; after finding, click its Home button;
+
:* Go to the Browser and try to find the Context that is associated with the problem part; use Tags and full text search; after finding it, click its Home button;
:* Try to search if your problem was already reported using text search string or tags;
+
:* Search to see if your problem has already been reported using text search string or tags;
:* If search is not successful, describe your problem in Problem (as well for Questions and Ideas) entry widget as full as possible;
+
:* If the search is not successful, describe your problem in Problem entry widget (as for Questions and Ideas) as fully as possible;
:* Any Context Contributor can reply with request for further information or with an answer;
+
:* Any Context Contributor can reply with a request for further information, or with an answer;
:* On the Network screen, you will be notified about gotten reply.
+
:* On the Network screen, you will be notified about a submitted reply.
    
Provide supporting materials.
 
Provide supporting materials.
    
:* Skilled people, somewhere on the Mothership level, create a set of Wiki pages;
 
:* Skilled people, somewhere on the Mothership level, create a set of Wiki pages;
:* Since initial Sugar Network won't support Wiki editing, using special tools these wiki pages will be uploaded to the Sugar Netowork to some Context, e.g., to Home Context;
+
:* Since the initial Sugar Network won't support Wiki editing, these wiki pages will be uploaded to the Sugar Network using special tools to some Context, e.g., to the Home Context;
:* Teachers/students can all time get these materials going to the Home Context and click Wiki.
+
:* Teachers/students can always get these materials by going to the Home Context and clicking Wiki.
   −
Sugar activity fails to start or fails on exit.
+
Suppose a Sugar activity fails to start or fails on exit.
   −
:* The activity fail dialog should have a complain field, describe your problem in there as full as possible;
+
:* The activity fail dialog should have a complaint field. Describe your problem there as fully as possible;
:* If Submit button was clicked (might be default), the repost with text message and activity logs will be attached to particular Release of the Context;
+
:* If Submit button was clicked (it might be the default action), the repost with text message and activity logs will be attached to the particular Release of the Context;
:* Context Contributor, browsing uploaded reports, can reply with request for further information or with an answer;
+
:* A Context Contributor, upon browsing uploaded reports, can reply with a request for further information, or with an answer;
:* On the Network screen, you will be notified about gotten reply.
+
:* On the Network screen, you will be notified about a submitted reply.
    
=== Content ===
 
=== Content ===
Line 264: Line 262:  
Sharing arbitrary education related media content.
 
Sharing arbitrary education related media content.
   −
:* Teacher (or any other User) creates new (or reuse existing) Wiki Context;
+
:* Teacher (or any other User) creates a new (or reuses an existing) Wiki Context;
:* Set appropriate, to the purpose, Tags and Context description;
+
:* Set Tags and a Context description that is appropriate to the purpose;
:* Create initial Wiki page, populate it and attach media content;
+
:* Create an initial Wiki page, populate it, and attach media content;
 
:* Students, using Tags and full-text search, explore the Context in the Browser;
 
:* Students, using Tags and full-text search, explore the Context in the Browser;
:* Being in the Browser, activate the found Context and being moved to the Wiki page.
+
:* Once in the Browser, activate the found Context for its transfer to the Wiki page.
   −
Sharing Activity object.
+
Sharing an Activity object.
   −
:* In after-creation dialog, there should be a button to share newly created object with the Network;
+
:* In an after-creation dialog, there should be a button to share a newly created object with the Network;
:* Journal should have a way to share any object by one click.
+
:* The Journal should have a way to share any object with one click.
    
=== Sugar activities ===
 
=== Sugar activities ===
Line 282: Line 280:  
:* Click found entity.
 
:* Click found entity.
   −
Launch particular activity version, e.g., to help with testing non-stable version or fallback to previous one because the recent doesn't work for you.
+
Launch particular activity version, e.g., to help with testing non-stable version or fallback to previous one because the recent version doesn't work for you.
    
:* Go to the Browser and explore the activity you want to start, maybe using the ''Activity'' Tag or full-text search;
 
:* Go to the Browser and explore the activity you want to start, maybe using the ''Activity'' Tag or full-text search;
:* Click Home button for found entity;
+
:* Click Home button for a found entity;
 
:* You should find the list of Releases with the recent stable Release chosen, select any version you want;
 
:* You should find the list of Releases with the recent stable Release chosen, select any version you want;
:* Click the Launch button, or run it from the Browser, to run newly selected Release.
+
:* Click the Launch button, or run it from the Browser, to run a newly selected Release.
    
=== Networkless ===
 
=== Networkless ===
   −
Sugar Network is all about being connected to a Sugar Network server, placed in the Internet (on-line case) or in a schoolserver (off-line case). But limited workflow is supported for server-less case.
+
The Sugar Network is all about being connected to a Sugar Network server someplace on the Internet (on-line case) or in a schoolserver (off-line case). A more limited workflow is supported for the server-less case.
   −
Being at school and connected to its Network server, prepare Contexts to work at home when Network won't be accessible:
+
Suppose one is at school and connected to its Network server to prepare Contexts to work on at home when a Network won't be accessible:
   −
:* Go to the Browser and explore the Context you want to work at home;
+
:* Go to the Browser and explore the Context you want to work on at home;
:* Pick up these Contexts (depends on implementation);
+
:* Pick up, select, collect these Contexts (depends on implementation);
:* Being at home when Network is not accessible, you will see all picked up Context in the Browser;
+
:* Once at home where a Network is not accessible, you will see all chosen Contexts in the Browser;
:* Limited functionality (depends on implementation) will be supported for these Contexts.
+
:* A limited functionality (depends on implementation) will be supported for these Contexts.
    
=== Teaching ===
 
=== Teaching ===
Line 309: Line 307:     
:* Go to the Browser and explore the activity you want to start, maybe using the ''Activity'' Tag or full-text search;
 
:* Go to the Browser and explore the activity you want to start, maybe using the ''Activity'' Tag or full-text search;
:* Click Home button for found entity;
+
:* Click Home button for the found entity;
 
:* ''TODO''
 
:* ''TODO''