IncreaseHardwareDatabaseParticipation

Differences between revisions 1 and 8 (spanning 7 versions)
Revision 1 as of 2006-11-07 00:14:44
Size: 1350
Editor: 207
Comment: bof notes
Revision 8 as of 2007-02-16 09:51:32
Size: 3275
Editor: 87
Comment:
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:
 * '''Launchpad entry''': [https://launchpad.net/distros/ubuntu/+spec/increase-hwdb-participation increase-hwdb-participation]  * '''Launchpad entry''': UbuntuSpec:increase-hwdb-participation
Line 11: Line 11:
Increase participation in the Ubuntu Hardware Database.
Line 12: Line 14:

In order to collect better data about hardware support in Ubuntu, we want more users to contribute their hardware data to the Ubuntu Hardware Database.

Users should be invited to participate when they boot a pre-release live CD and when they install Ubuntu (whether the installation is successful or not).
Line 15: Line 21:
 * The Ubuntu development team would like to have better information about hardware on which installations consistently fail, or on which certain classes of bugs are consistently reported.
Line 16: Line 24:

Significant changes to `hwdb-client` are discussed in [https://features.launchpad.net/distros/ubuntu/+spec/hwdb-overhaul hwdb-overhaul] rather than here.
Line 19: Line 29:
== Implementation == We will add a post-installation update-notifier notification which appears on the live session desktop and immediately after new installs prompting the user to contribute to the hardware database; It is possible to disable this by means of debconf preseeding for the benefit of automatic installations (key `hwdb-client/notification`). Also, this notification will not be shown if the user already has a `~/.hwdb` state file.
Line 21: Line 31:
=== Code === == Code ==
Line 23: Line 33:
=== Data preservation and migration === In order to do this properly, update-notifier needs to support two additional fields in the notification description fields:
Line 25: Line 35:
== Unresolved issues ==  * `GettextDomain:` If present, update-notifier uses `dgettext()` to translate the field instead of the inline ''Name''`-`''Locale'' fields.
 * `DisplayIf:` If this points to an existing executable script, the notification is only shown if the script exits with zero.
Line 27: Line 38:
== BoF agenda and discussion == hwdb-client then:
Line 29: Line 40:
{{{
live session:
 - add another icon (or a notification bubble) to the live session desktop to st
art hwdb-client
 * ships a postinst file that checks for the debconf preseeding key `hwdb-client/notification` and creates a stamp file `/var/lib/hwdb-client-common/no-notification` if the notification should be supressed.
 * ship a notification display test script that exits with zero iff neither `/var/lib/hwdb-client-common/no-notification` nor `~/.hwdb` exists.
 * ensures in the packaging that the translatable parts of the u-n notification are copied to the PO template at build time.
Line 34: Line 44:
post-install:
 - notification bubble on new install
 - once acknowledged, never appears again (unless hardware changes)
 - prompting causes problems for automatic installations, but we can probably wo
rk around this (e.g. default to off and turn on during manual installations)
== Future work ==
Line 40: Line 46:
make hwdb-client accessible from menus again If something goes wrong while dealing with removable devices, the relevant UI should ask the user to re-submit to the hardware database with that removable device plugged in as well as asking them to file a bug.
Line 42: Line 48:
for bonus points:
 - if something goes wrong while dealing with removable devices, ask user to re-
submit to hardware database and/or file a bug
 - tie into apport?
}}}
`apport` should offer to submit a hardware database entry if this has not already been done, and inform the user of the ID so that they can quote it in their bug report if they want to do so.

== Discussion ==

 * I think more people will participate if they see their contribution somewhere on the web, similar to http://popcon.debian.org/ . When these data are used for statistics, people tend to "vote" for their hardware by submitting their profile.

Please check the status of this specification in Launchpad before editing it. If it is Approved, contact the Assignee or another knowledgeable person before making changes.

Summary

Increase participation in the Ubuntu Hardware Database.

Rationale

In order to collect better data about hardware support in Ubuntu, we want more users to contribute their hardware data to the Ubuntu Hardware Database.

Users should be invited to participate when they boot a pre-release live CD and when they install Ubuntu (whether the installation is successful or not).

Use cases

  • The Ubuntu development team would like to have better information about hardware on which installations consistently fail, or on which certain classes of bugs are consistently reported.

Scope

Significant changes to hwdb-client are discussed in [https://features.launchpad.net/distros/ubuntu/+spec/hwdb-overhaul hwdb-overhaul] rather than here.

Design

We will add a post-installation update-notifier notification which appears on the live session desktop and immediately after new installs prompting the user to contribute to the hardware database; It is possible to disable this by means of debconf preseeding for the benefit of automatic installations (key hwdb-client/notification). Also, this notification will not be shown if the user already has a ~/.hwdb state file.

Code

In order to do this properly, update-notifier needs to support two additional fields in the notification description fields:

  • GettextDomain: If present, update-notifier uses dgettext() to translate the field instead of the inline Name-Locale fields.

  • DisplayIf: If this points to an existing executable script, the notification is only shown if the script exits with zero.

hwdb-client then:

  • ships a postinst file that checks for the debconf preseeding key hwdb-client/notification and creates a stamp file /var/lib/hwdb-client-common/no-notification if the notification should be supressed.

  • ship a notification display test script that exits with zero iff neither /var/lib/hwdb-client-common/no-notification nor ~/.hwdb exists.

  • ensures in the packaging that the translatable parts of the u-n notification are copied to the PO template at build time.

Future work

If something goes wrong while dealing with removable devices, the relevant UI should ask the user to re-submit to the hardware database with that removable device plugged in as well as asking them to file a bug.

apport should offer to submit a hardware database entry if this has not already been done, and inform the user of the ID so that they can quote it in their bug report if they want to do so.

Discussion

  • I think more people will participate if they see their contribution somewhere on the web, similar to http://popcon.debian.org/ . When these data are used for statistics, people tend to "vote" for their hardware by submitting their profile.


CategorySpec

IncreaseHardwareDatabaseParticipation (last edited 2008-08-06 16:18:56 by localhost)