Working groups/addon directory

From Habari Project

Jump to: navigation, search

Contents

Addons Working Group

The Addons WG is responsible for development of a browsable and searchable addons catalog on hp.o. The catalog will house information and downloads of plugins, themes, locales, and other addons.

Goal

  • Repository for addons, both in -extras and elsewhere.
  • Browsable and searchable.
  • Easy for developers to update.
  • Downloadable bundles of addons.

Personas

There are several different types of people whose needs should be met by the addons catalog.

Users

People who want to find addons appropriate for the version of Habari that they're using. They may be looking for a specific addon by name, by functionality, maybe a general type (admin plugins, minimalist themes), or just to browse in general.

Browse site for plugins (and other non-theme addons)

User visits the site, and is presented with a list of the most recently updated plugins for the current release version of Habari. There is a link to change browsing preferences to look for plugins targeting the in development version of Habari, as well as (possibly) previous releases. Clicking on the name of an addon leads to the detail page for that addon. Links also lead to sections for each type of addon -- themes, plugins, locales, scripts.

Browse site for themes

User visits the site, and sees a visual catalog of themes (screenshots) on the themes landing page based on newness, or popularity (to be measured in ratings or downloads or something), for the current release version of Habari. There is a link to change browsing preferences to look for themes targeting the in development version of Habari, as well as (possibly) previous releases. If the user wants more information or to download one of those themes presented on the page clicking on its title or screenshot will lead to a detail page with all theme information, including links to its author and (if applicable) source code repository, as well as links to other releases of it (other Habari versions, etc). If the theme makes use of, or requires, provided features, they will be listed as well. On that page will also be links based on attributes (tags) for other themes (styling, number of columns, etc).

Search site 
(write the process here)

All text should be searchable, whether in title, descriptions, or other data fields. Intelligent matching would help people searching for "Foo Plugin" find "FooPlugin" and vice versa. Users can search the whole site, or just one area of addons.

Download from site 
(write the process here)

Whether a user download a plugin coming from -extras or from outside, the process should remain the same. The file directory should house both type of plugins, be recognized/trustable (like sourceforge for example) and permit easy modification (bitbucket, github). The plugins "from outside" will have to be reviewed before being added (for virus/malware in particular) example of such process: https://addons.mozilla.org/en-US/developers/docs/policies/reviews. Only links to our file directory will be available. If we ever implement a search/download feature from inside the habari admin: provide an alternative link (click to copy?) which when pasted in the appropriate field in habari will download (and activate?) the plugin selected.

Browse from admin 
(write the process here)
Search from admin 
(write the process here)
Download in admin 
(is this a good idea yes, it is a good option to have ? write the process here)

Developers with addons in -extras

People for whom the Habari project hosts addons in the -extras repository.

Initial upload 
(write the process here)
New version 
(write the process here)

Developers with addons outside -extras

People who have an addon hosted outside -extras, for example for licensing reasons.

Initial upload 
(write the process here)
New version 
(write the process here)

Addon metadata

The catalog should manage information about addons. The required information should be kept to a minimum, and may be different depending on the type of addon.

The following information may be available for an addon.

  • Name
  • Description
  • Versions
  • License
  • Author
  • Link
  • Author link
  • Screenshots
  • Video
  • Copyright information
  • (more?)

Trust

Users need to be able to trust addons, and the catalog should provide means to support the development of trust. Below are some mechanisms that might be helpful.

Ratings

Users can rate an addon.

Reputation

Users can gain reputation by doing good things. A higher reputation gives their ratings more weight.

Signing

Registered users can sign addons. They could upload their public key to their profile on the site.

Review State

Addons outside of -extras must be reviewed.

Implementation

Work in progress can be found on Github: [1]

How Github Pings are Processed


Members

Personal tools