Difference between revisions of "Features/Multiple schoolserver registration"

From Sugar Labs
Jump to navigation Jump to search
(Created page with "<noinclude> Category:Feature Page Incomplete . <!-- You can add categories to tie features back to real deployments/schools requesting them, for examp...")
 
Line 5: Line 5:
 
[[Category:Features requested by School Xyz|<Feature Name>]] (the |Feature Name option sorts the entry on the category page under the first letter of <Feature Name>). -->
 
[[Category:Features requested by School Xyz|<Feature Name>]] (the |Feature Name option sorts the entry on the category page under the first letter of <Feature Name>). -->
 
</noinclude>
 
</noinclude>
−
 
−
<!-- All fields on this form are required to be accepted.
 
−
We also request that you maintain the same order of sections so that all of the feature pages are uniform.  -->
 
−
 
−
<!-- The actual name of your feature page should look something like: Features/Your Feature Name.  This keeps all features in the same namespace -->
 
  
 
== Summary ==
 
== Summary ==
Line 26: Line 21:
  
 
== Detailed Description ==
 
== Detailed Description ==
 +
In case a user wants to register to a new XS server, he/she has to first manually clear the previous registration details(if present). He/she has to create new registration even if he/she returns back to an XS server where his laptop has been registered before. Every new registration changes the serial number of the laptop and serial number is used in backup url and backup paths for that laptop in the XS server. Hence registering multiple times with the same XS server leads to unnecessary change in backup path.
 +
 +
Also from the various field reports where a user (generally a teacher) has to register to multiple XS servers on move, it becomes difficult to keep clearing the registration details manually. ([https://bugs.sugarlabs.org/ticket/362 one such report here])
 +
The present system for registering a Sugar laptop with an XS server is depicted below.
 +
[[File:Sugar-server-present.png|1000px]]
  
 +
*This feature is aimed to enhance the Sugar-Server interaction that would include:
 +
**Automated management of registration data so that a user can connect to an XS server with only one click regardless of the server being new or previously registered, hence enabling quick hop between multiple XS servers.
 +
**Creating a new control panel section named "Server" to house the server related settings and provide a reorganized place for future settings to come.
 +
**Retain the registration data required for ds-backup if present in the system so that it can maintain its functionality.
 +
The following is the proposed flow being developed for the feature:
 +
[[File:Sugar-server-modified.png|1000px]]
 +
*The main advantages of the above flow are:
 +
**Manual clear of registration is not required.
 +
**Each laptop will have same backup url and backup path (in XS:/library/users) for a particular XS as it was created on first registration with the server. As registration will be done only once. The "Register" button would rather say "Connect to Server". When user connects to an XS where it has registered previously (identified by the presence of pubkey), it would simply set its serial number, uuid and backup-url with the pre-registration data. This would enable better and advanced management of backups.
 +
*No extra input is required from the user. The user just has to connect to the XS server ssid and specify the jabber-server address as before.
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
−
''What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Sugar become a better platform or project because of this feature?''
+
This feature has emerged from a [https://bugs.sugarlabs.org/ticket/362 bug].
−
 
+
The feature is supposed to bring Sugar closer to XS server and improve the user experience.  
−
''Make sure to note here as well if this feature has been requested by a specific deployment, or if it has emerged from a bug report.''
 
  
 
== Scope ==
 
== Scope ==
Line 37: Line 46:
  
 
==UI Design==
 
==UI Design==
−
''Does the feature have a direct impact on the work flow, or does it need a UI? Link here mockups, or add detailed descriptions.''
+
The user does not have to provide any extra input. He/she has to provide the jabber server url and click on the button to register to it as before. So no change of UI is required to achieve the functionality. But as discussed in the developer mailing list ([http://lists.sugarlabs.org/archive/sugar-devel/2016-April/052071.html link]), it has been emphasized that a new control panel section named "Server" should be created. This section will as of now only have two user inputs "Jabber Server" and "Collaboration Server" which will be moved in from its present location of the "Network" control panel section.
  
 
== How To Test ==
 
== How To Test ==
 
{{:{{PAGENAME}}/Testing}}
 
{{:{{PAGENAME}}/Testing}}
 
== User Experience ==
 
== User Experience ==
−
''If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice.''
+
The user experience is believed to increase quite significantly as it can be judged from the problems that are being faced now in this [https://bugs.sugarlabs.org/ticket/362 bug]
  
 
== Dependencies ==
 
== Dependencies ==
−
''What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, does your feature depend on completion of another feature owned by someone else or that you would need to coordinate, which might cause you to be unable to finish on time?  Other upstream projects like Python?''
+
None
  
−
== Contingency Plan ==
+
<!--== Contingency Plan ==
 
''If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''
 
''If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''
  
Line 54: Line 63:
  
 
== Release Notes ==
 
== 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.''
+
''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.'' -->
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==

Revision as of 21:43, 14 April 2016


Summary

Easily hop between multiple XS servers. Sugar will be able to register to multiple XS servers easily, without the need of clearing the registrations manually.

Owner

  • Email: mpdmanash@gmail.com

Current status

  • Targeted release: (SUGAR_VERSION)
  • Last updated: 15 April 2016
  • Status: Being discussed and development started

Detailed Description

In case a user wants to register to a new XS server, he/she has to first manually clear the previous registration details(if present). He/she has to create new registration even if he/she returns back to an XS server where his laptop has been registered before. Every new registration changes the serial number of the laptop and serial number is used in backup url and backup paths for that laptop in the XS server. Hence registering multiple times with the same XS server leads to unnecessary change in backup path.

Also from the various field reports where a user (generally a teacher) has to register to multiple XS servers on move, it becomes difficult to keep clearing the registration details manually. (one such report here) The present system for registering a Sugar laptop with an XS server is depicted below. Sugar-server-present.png

  • This feature is aimed to enhance the Sugar-Server interaction that would include:
    • Automated management of registration data so that a user can connect to an XS server with only one click regardless of the server being new or previously registered, hence enabling quick hop between multiple XS servers.
    • Creating a new control panel section named "Server" to house the server related settings and provide a reorganized place for future settings to come.
    • Retain the registration data required for ds-backup if present in the system so that it can maintain its functionality.

The following is the proposed flow being developed for the feature: Sugar-server-modified.png

  • The main advantages of the above flow are:
    • Manual clear of registration is not required.
    • Each laptop will have same backup url and backup path (in XS:/library/users) for a particular XS as it was created on first registration with the server. As registration will be done only once. The "Register" button would rather say "Connect to Server". When user connects to an XS where it has registered previously (identified by the presence of pubkey), it would simply set its serial number, uuid and backup-url with the pre-registration data. This would enable better and advanced management of backups.
  • No extra input is required from the user. The user just has to connect to the XS server ssid and specify the jabber-server address as before.

Benefit to Sugar

This feature has emerged from a bug. The feature is supposed to bring Sugar closer to XS server and improve the user experience.

Scope

What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?

UI Design

The user does not have to provide any extra input. He/she has to provide the jabber server url and click on the button to register to it as before. So no change of UI is required to achieve the functionality. But as discussed in the developer mailing list (link), it has been emphasized that a new control panel section named "Server" should be created. This section will as of now only have two user inputs "Jabber Server" and "Collaboration Server" which will be moved in from its present location of the "Network" control panel section.

How To Test

Features/Multiple schoolserver registration/Testing

User Experience

The user experience is believed to increase quite significantly as it can be judged from the problems that are being faced now in this bug

Dependencies

None


Comments and Discussion

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Features/Multiple_schoolserver_registration&oldid=98042"