Planet
4233
Comment:
|
4263
|
Deletions are marked like this. | Additions are marked like this. |
Line 3: | Line 3: |
This is currently is the Discussion phase. Nothing here is set in stone and will be expanded on. | The project is currently in alpha development and a sample is available. This sample is just that, massive changes will occur. |
PHASE
The project is currently in alpha development and a sample is available. This sample is just that, massive changes will occur.
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
Project Lead |
|
Lead Developer |
|
RTL Developer |
Specifications
- Authentication
- Authentication will be based on user groups.
- Authentication levels [ administer, edit, view ]
- Administer - Able to edit every aspect of the module
- Edit - Able to view content and edit all feeds
- Except feeds locked by administrators
- View - Able to view content only
- Design
- Content
Page - Will resemble the page content of http://planet.ubuntu.com
- Headings should be displayed separating feed dates (July 01, 2009)
- Module should use user profile icons as display icons
- Module will show a default icon if no user icon is set
- Feed will be formed in a "speech bubble"
- Feed heading will be a link to the original article
- Feed summary will follow heading
- Date/Time of post will be posted in bottom right of bubble - not a link
- If not full feed, _Read_More_ link will be available
Block - Will resemble the Feeds section of http://planet.ubuntu.com
- Block will contain a list of all users that have feeds
- Block will form a link to the users blog
- Block will form a link to the users feed
- Links will be in the form of User (feed)
- Help section
- Must document all options
- Must document how to use them properly
- How do disable blocks from displaying on planet page
- Workings
- Module should pull all feeds from users and sort based on date/time
- RSS
- Module should allow and RSS feed to be pulled from the planet
- Update
- Module must update on cron
- Administration
- Separate pages for administrating the planet and the feeds
- Administrators must be able to:
- Edit all feeds regardless of lock status
- [Freeze] Stop a feed from being aggregated to the planet
- [Lock] Stop other users from being able to edit the feed
- Edit administrative module settings
- Editors must be able to:
- Edit all unlocked feeds
- Edit frozen feeds and unlock if it's their own
- Viewers must be able to view a full page of content
- Administration settings:
- Must be able to configure maximum feeds for page
- Must be able to set maximum number of feeds per user
- Must be able to (en|dis)able the user icons
- Must be able to set maximum length of feed
- Must be able to enable/disable viewing of images
- Content
- Defaults
- All feeds should start out unlocked and unfrozen
- Code
- CSS
- CSS should be created to resemble planet.ubuntu.com
- Standards
- Code must be properly documented
- Functions should perform a small task
- Comments should occur before the function, not in it
- Code should be clean and readable
- No redundant functions should exist
- Drupal coding specs should be taken
- Module.install file should cover the exactly full ground
- Any other common sense coding approaches should be taken
- CSS
- UNKNOWN
- Should module pull the feed down and store it locally or should is store a reference to the link?
- Do we want to use the aggregator module as a requirement to the module and use some of it's functions?
- What else should we add to the spec?
Notes
- Incomplete specification
Complete specification
Verified specification - after all specs met
UbuntuDrupal/Specs/Planet (last edited 2009-12-05 20:55:01 by 138)