PHASE

The project is currently stable. This is in production at http://sd.ubuntu-us.org/planet.

Purpose

The purpose of the Ubuntu Drupal Planet module is to mimic the way PlanetPlanet works. A sample of PlanetPlanet can be seen on http://planet.ubuntu.net/.

Design

A focus will be held on end user functionality as well as the overall "eye appeal" which includes graphics. A style.css and a style-rtl.css will be built to handle multiple languages.

Developers

Specifications

1. Authentication

   1. Authentication will be based on user groups.

   2. Authentication levels [ administer, edit, view ]

      1. Administer - Able to edit every aspect of the module

      2. Edit - Able to view content and own feeds

         1. Except feeds locked by administrators

      3. View - Able to view content only

2. Design

   1. Content

      1. Page - Will resemble the page content of http://planet.ubuntu.com

         1. Headings should be displayed separating feed dates (July 01, 2009)

         2. Module should use user profile icons as display icons

         3. Module will show a default icon if no user icon is set

         4. Feed will be formed in a "speech bubble"

         5. Feed heading will be a link to the original article

         6. Feed summary will follow heading

         7. Date/Time of post will be posted in bottom right of bubble

         8. If not full feed, _Read_More_ link will be available

      2. Block - Will resemble the Feeds section of http://planet.ubuntu.com

         1. Block will contain a list of all users that have feeds

         2. Block will form a link to the users blog

         3. Block will form a link to the users feed

         4. Block will allow a custom header to be added

         5. Block will allow a custom footer to be added

   2. Help section

      1. Must document all options

      2. Must document how to use them properly

      3. How do disable blocks from displaying on planet page

   3. Workings

      1. Module should pull all feeds from users and sort based on date/time

   4. RSS Support must be available

   5. Update

      1. Module must update on cron

   6. Administration

      1. Separate pages for administrating the planet and the feeds

      2. Administrators must be able to:

         1. Edit all feeds regardless of lock status

         2. [Freeze] Stop a feed from being aggregated to the planet

         3. Edit administrative module settings

      3. Editors must be able to:

         1. Edit own unlocked feeds

         2. Edit disabled feeds and unlock if it's their own

      4. Viewers must be able to view a full page of content

   7. Administration settings:

      1. Must be able to configure maximum feeds for page

      2. Must be able to set maximum number of feeds per user

      3. Must be able to (en|dis)able the user icons

      4. Must be able to set maximum length of feed

      5. Must be able to enable/disable viewing of images

      6. Must offer easy way to manage user pictures

3. Defaults

   1. All feeds should start out unlocked and unfrozen

4. Code

   1. RTL style must exist

   2. CSS

      1. CSS should be created to resemble planet.ubuntu.com

   3. Standards

      1. Code must be properly documented

      2. Functions should perform a small task

      3. Comments should occur before the function, not in it

      4. Code should be clean and readable

      5. No redundant functions should exist

      6. Drupal coding specs should be taken

      7. Module.install file should cover the exactly full ground

      8. Any other common sense coding approaches should be taken