UbuntuOneFirefoxBookmarkSyncing

Differences between revisions 9 and 10
Revision 9 as of 2009-06-16 14:56:46
Size: 2605
Editor: pool-96-248-6-186
Comment: ## page was copied from SpecTemplate
Revision 10 as of 2009-06-16 16:28:07
Size: 3355
Editor: pool-96-248-6-186
Comment:
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
 * '''Created''':
 * '''Contributors''':
 * '''Packages affected''':
 * '''Created''': urbanape
 * '''Contributors''': urbanape
 * '''Packages affected''': karmic
Line 11: Line 11:
This should provide an overview of the issue/functionality/change proposed here. Focus here on what will actually be DONE, summarising that so that other people don't have to read the whole spec. See also CategorySpec for examples. We will create a Firefox extension that will enable syncing of bookmarks to UbuntuOne by storing them in the local CouchDB instance (replication of that content is out of scope of this plugin, and is presumably already established functionality). Since the local CouchDB instance operates on a known port, and Firefox 3+ provides bookmark (Places) modification events we can observe, there's no need for any preferences UI.
Line 15: Line 15:
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.
You can now sync your Firefox bookmarks with UbuntuOne.
Line 21: Line 19:
This should cover the _why_: why is this change being proposed, what justifies it, where we see this justified. Bookmarks are precious data, and are more useful when shared and easily replicated between machines.
Line 25: Line 23:
=== Initial Sync ===

Alice has two machines in her house, a desktop and a netbook. Both run Ubuntu Karmic, and she has an UbuntuOne account. She enables bookmark syncing on her desktop computer, and the plugin first syncs the existing bookmarks with UbuntuOne.

=== The Second Machine ===

Alice enables bookmark syncing on her netbook, and the plugin syncs existing bookmarks, merging them from UbuntuOne if necessary. Now her bookmarks on the netbook are identical to the bookmarks on the desktop.

=== The Coffee Shop ===

Alice takes her netbook to the coffee shop to meet a potential client. He shows her some sites he's mocked up, and she bookmarks them for later research. When she returns home, the new bookmarks are already available on her desktop version of Firefox.
Line 26: Line 36:

Conflict resolution is handled by CouchDB. This extension just pulls and pushes the collection of bookmarks.
Line 37: Line 49:
Should cover changes required to the UI, or specific UI that is required to implement this This first version will have little to no UI. Since we're operating on a known port and we'll be responding to javascript events, we don't need to establish host/port or frequency.
Line 45: Line 57:
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.
N/A
  • Launchpad Entry: foo

  • Created: urbanape

  • Contributors: urbanape

  • Packages affected: karmic

Summary

We will create a Firefox extension that will enable syncing of bookmarks to UbuntuOne by storing them in the local CouchDB instance (replication of that content is out of scope of this plugin, and is presumably already established functionality). Since the local CouchDB instance operates on a known port, and Firefox 3+ provides bookmark (Places) modification events we can observe, there's no need for any preferences UI.

Release Note

You can now sync your Firefox bookmarks with UbuntuOne.

Rationale

Bookmarks are precious data, and are more useful when shared and easily replicated between machines.

User stories

Initial Sync

Alice has two machines in her house, a desktop and a netbook. Both run Ubuntu Karmic, and she has an UbuntuOne account. She enables bookmark syncing on her desktop computer, and the plugin first syncs the existing bookmarks with UbuntuOne.

The Second Machine

Alice enables bookmark syncing on her netbook, and the plugin syncs existing bookmarks, merging them from UbuntuOne if necessary. Now her bookmarks on the netbook are identical to the bookmarks on the desktop.

The Coffee Shop

Alice takes her netbook to the coffee shop to meet a potential client. He shows her some sites he's mocked up, and she bookmarks them for later research. When she returns home, the new bookmarks are already available on her desktop version of Firefox.

Assumptions

Conflict resolution is handled by CouchDB. This extension just pulls and pushes the collection of bookmarks.

Design

You can have subsections that better describe specific parts of the issue.

Implementation

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

UI Changes

This first version will have little to no UI. Since we're operating on a known port and we'll be responding to javascript events, we don't need to establish host/port or frequency.

Code Changes

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

Migration

N/A

Test/Demo Plan

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.

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.

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.


CategorySpec

UbuntuOneFirefoxBookmarkSyncing (last edited 2009-06-16 20:28:08 by pool-96-248-6-186)