IntegratingWithUbuntuOne

Differences between revisions 4 and 5
Revision 4 as of 2009-06-17 16:03:13
Size: 4032
Editor: joshuahoover
Comment:
Revision 5 as of 2009-06-17 17:00:24
Size: 5445
Editor: joshuahoover
Comment:
Deletions are marked like this. Additions are marked like this.
Line 14: Line 14:
This section should include a paragraph describing the end-user impact of this change. It is meant to be included in the release notes of the first release in which it is implemented. (Not all of these will actually be included in the release notes, at the release manager's discretion; but writing them is a useful exercise.)

It is mandatory.

== Rationale ==
TBD...
Line 23: Line 19:

== Assumptions ==
TBD...
Line 29: Line 24:
File sharing and syncronization allows users to share and synchronize files across their local network. An optional capability will allow users to easily share and synchronize files across the Internet using the Ubuntu One online service.

The Ubuntu One client will no longer use a client applet (as is the case with the current beta). Instead, the client will use downloads, FUSA, and standard Ubuntu messaging indicators.
Line 35: Line 34:
Provides screen sharing between two desktops using Empathy, Telepathy. The "Share My Desktop" dialog will be unaffected. An optional Ubuntu One service will provide a proxy (utilizing ejabberd on the server) to allow users to more easily share their screens across the Internet.
Line 42: Line 43:
'''Overview''': [[http://couchdb.apache.org/|Apache CouchDB]] is a distributed, fault-tolerant and schema-free document-oriented database accessible via a RESTful HTTP/JSON API. CouchDB is the database for Ubuntu One data sharing and synchronization capabilities.

Each user will run their own instance of CouchDB, which is different than the standard install of the current CouchDB package. There is also a need to setup various CouchDB configuration files, design docs, and triggers. Additional capabilities will be added to CouchDB, including [[http://oauth.net/|OAuth]] support and document history.

In order for developers to more easily use CouchDB in their applications, we will provide libraries for a variety of languages and environments, including Python, DBUS, and GTK (GLib).
Line 57: Line 64:
Providing a CouchDB contacts database that all Ubuntu applications can use is one of the key applications of the Ubuntu One data sharing and synchronization capability. Integration with Evolution, Akonadi, and Gwibber will store contacts in CouchDB. Developers of GTK applications will have a GTK widget which can provide their applications with a way to easily lookup/select contacts from the contacts CouchDB database. There will also be a contacts API for Python and DBUS, which will allow developers to use the CouchDB contacts database without worrying about the underlying details of CouchDB and the contacts schema.
Line 58: Line 67:
 * evolution-couchdb
 * akonadi-couchdb
 * gwibber-couchdb
Line 61: Line 73:
 * evolution-couchdb
 * akonadi-couchdb
 * gwibber-couchdb
Line 66: Line 75:
A Firefox bookmarks synchronization and sharing extension will store Firefox bookmarks in CouchDB, which will provide sharing and synchronization capabilities.
Line 70: Line 81:
Tomboy will use CouchDB for storing its data which will provide sharing and synchronization capabilities.
Line 74: Line 87:
The packages below will provide general
Line 78: Line 92:
=== File ===
Line 101: Line 114:
It's important that we are able to test new features, and demonstrate them to users. Use this section to describe a short plan that anybody can follow that demonstrates the feature is working. This can then be used during testing, and to show off after release. Please add an entry to http://testcases.qa.ubuntu.com/Coverage/NewFeatures for tracking test coverage.

This need not be added or completed until the specification is nearing beta.
TBD
Line 109: Line 120:
== BoF agenda and discussion ==

Use this section to take notes during the BoF; if you keep it in the approved spec, use it for summarising what was discussed and note any options that were rejected.
  • Launchpad Entry: Integrating with Ubuntu One

  • Created: 2009-06-17

  • Contributors:

  • Packages affected: python-contacts-api, dbus-contacts-api, gtk-contacts-picker, erlang, couchdb, couchdb-bin, ubuntu-couchdb, couchdb-oauth, couchdb-history, ubutuone-sync-ui, evolution-couchdb, akonadi-couchdb, tomboy-couchdb, firefox-bookmarks-couchdb, python-couchdb, couchdb-glib, dbus-couchdb, python-couchdb-records-api, dbus-couchdb-records-api, icontool, ubuntuone-client, ubuntuone-storage-protocol, python-oauth, ubuntuone-screensharing, ejabberd, configglue, gwibber-couchdb

Summary

Ubuntu One provides capabilities for the Ubuntu desktop as well as extended capabilities via optional online services. Integrating Ubuntu One capabilities with the Ubuntu desktop will provide storage sharing & synchronization (across a LAN and (optionally) the Ubuntu One cloud), screen sharing, and data (contacts, notes, Firefox bookmarks) sharing & synchronization via CouchDB.

Release Note

TBD...

User stories

TBD...

Design

File Sharing & Synchronization

File sharing and syncronization allows users to share and synchronize files across their local network. An optional capability will allow users to easily share and synchronize files across the Internet using the Ubuntu One online service.

The Ubuntu One client will no longer use a client applet (as is the case with the current beta). Instead, the client will use downloads, FUSA, and standard Ubuntu messaging indicators.

Packages:

  • icontool
  • ubuntuone-client
  • ubuntuone-storage-protocol

Screen Sharing

Provides screen sharing between two desktops using Empathy, Telepathy. The "Share My Desktop" dialog will be unaffected. An optional Ubuntu One service will provide a proxy (utilizing ejabberd on the server) to allow users to more easily share their screens across the Internet.

Packages:

  • ubuntuone-screensharing
  • ejabberd

Data Sharing & Synchronization

CouchDB

Overview: Apache CouchDB is a distributed, fault-tolerant and schema-free document-oriented database accessible via a RESTful HTTP/JSON API. CouchDB is the database for Ubuntu One data sharing and synchronization capabilities.

Each user will run their own instance of CouchDB, which is different than the standard install of the current CouchDB package. There is also a need to setup various CouchDB configuration files, design docs, and triggers. Additional capabilities will be added to CouchDB, including OAuth support and document history.

In order for developers to more easily use CouchDB in their applications, we will provide libraries for a variety of languages and environments, including Python, DBUS, and GTK (GLib).

Packages:

  • erlang
  • couchdb
  • couchdb-bin
  • ubuntu-couchdb
  • couchdb-oauth
  • couchdb-history
  • ubuntuone-sync-ui
  • python-couchdb
  • couchdb-glib
  • dbus-couchdb
  • python-couchdb-records-api
  • dbus-couchdb-records-api

Contacts

Providing a CouchDB contacts database that all Ubuntu applications can use is one of the key applications of the Ubuntu One data sharing and synchronization capability. Integration with Evolution, Akonadi, and Gwibber will store contacts in CouchDB. Developers of GTK applications will have a GTK widget which can provide their applications with a way to easily lookup/select contacts from the contacts CouchDB database. There will also be a contacts API for Python and DBUS, which will allow developers to use the CouchDB contacts database without worrying about the underlying details of CouchDB and the contacts schema.

Packages:

  • evolution-couchdb
  • akonadi-couchdb
  • gwibber-couchdb
  • python-contacts-api
  • dbus-contacts-api
  • gtk-contacts-picker

Bookmarks (Firefox)

A Firefox bookmarks synchronization and sharing extension will store Firefox bookmarks in CouchDB, which will provide sharing and synchronization capabilities.

Packages:

  • firefox-bookmarks-couchdb

Notes (Tomboy)

Tomboy will use CouchDB for storing its data which will provide sharing and synchronization capabilities.

Packages:

  • tomboy-couchdb

Misc

The packages below will provide general Packages:

  • python-oauth
  • configglue

Implementation

This section should describe a plan of action (the "how") to implement the changes discussed. Could include subsections like:

UI Changes

Should cover changes required to the UI, or specific UI that is required to implement this

Code Changes

Code changes should include an overview of what needs to change, and in some cases even the specific details.

Migration

Include:

  • data migration, if any
  • redirects from old URLs to new ones, if any
  • how users will be pointed to the new way of doing things, if necessary.

Test/Demo Plan

TBD

Unresolved issues

This should highlight any issues that should be addressed in further specifications, and not problems with the specification itself; since any specification with problems cannot be approved.


CategorySpec

DesktopTeam/Specs/Karmic/IntegratingWithUbuntuOne (last edited 2009-07-15 13:54:04 by joshuahoover)