Design/CreativeCollective/Docs

The following are rough notes containing documentation and business rules for the MCC and CF sites.

Home Page

• The "Hot Designs" features 9 designs that have been hand-selected by MCC editors at http://creative.mozilla.com/admin/hot_designs
  • The "Hot Designs" area used to pull in the 9 designs that have been liked the most number of times within the last 7 days.
• The "Top Designs" area is only being shown to users who are not logged in. The Top 3 designs are the designs that have the highest total number of views since the site was created.
• The "Artists You Like" area is only being shown users who are logged in, and replaces the "Top Designs". This will pull the last 3 designs uploaded by artists of whom you are a fan. It will only display unique artists, meaning that you will not see art by the same artist in that display of 3 designs.

Badges

• A badge is an award that a user and / or a design may earn for specific achievements on the site.
• In order for a new badge to be added to the site, it must be added in the Badges admin panel, as well as in the code by a developer.
• A badge may not be revoked from a user through site interaction.
• A badge may be manually revoked from a user by a site admin.
• Badges can be edited at: http://creative.mozilla.org/admin/badges

Challenges (V2 - After February 2010)

• A challenge is a competition to which members of the Mozilla Creative Collective may submit their designs.

• Admins will create a challenge in the Challenge Admin screen at http://creative.mozilla.org/admin/challenges.

• A Challenge will contain the following pieces of data:
  • Title
  • Teaser
  • Description
  • Details and Official Rules
  • Challenge Finalists (5 design ID #s) - Selected by staff members.
  • Challenge Submission Start Date - The date upon which the challenge begins.
  • Challenge Submission End Date - The date upon which design submissions will no longer be accepted.
  • Challenge Voting Start Date - The date upon which members may begin voting on designs entered in this challenge.
  • Challenge Voting End Date - The date upon which vote submissions for designs entered in this challenge will no longer be accepted.
• Status (Active or Inactive)

• Dates
  • The Challenge Submission Start Date must occur before the Challenge Submission End Date.
  • The Challenge Submission End Date must occur before the Challenge Voting Start Date.
  • The Challenge Voting Start Date must occur before the Challenge Voting End Date.
  • Only 1 challenge can be considered the current challenge.
    • The period between a Challenge Submission Start Date and the Challenge Voting End Date may not overlap any other active (status = 1) challenge.

• Challenge Participation
  • Designs may only be submitted to the Creative Collective by website members.
  • In order to participate in a challenge, a member must select the checkbox "Enter This Design to X Challenge" in the Add a Design page.
  • Each design may only be entered into 1 challenge.
  • Admins may manually remove a design from a challenge in the Design Admin page.

• Selecting Challenge Finalists
  • Staff members must select 5 Challenge Finalists in the Challenge Admin screen.
  • Selection must take place in the period after the Challenge Submission End Date and before the Challenge Voting Start Date.
  • Staff members will manually notify the winner and runners up of their achievement.

• Design Likes
  • Each website member may "like" any design in the challenge, but this will have no effect upon challenge voting.

• Voting
  • Only website members may vote for a design.
  • A website member must be logged-in to the site in order to vote on a design.
  • Each website member may vote any or all of the 5 designs that have been entered in this challenge and has been selected by a staff member as a Challenge Finalist.
  • Each website member may vote in as many challenges as they would like.
  • A website member may not revoke their vote once they have voted.
  • The challenge landing page will will display the number of votes each design has received in this challenge.

• Selecting Challenge Winners
  • Once the Challenge Voting Start Date has passed, challenge votes will no longer be received.
  • The landing page for this challenge will automatically declare the winner and 4 runners up, based on the number of votes received by website members.
  • Staff members will manually notify the winner and runners up of their achievement.

• Challenge Landing Page
  • The Challenge Landing Page should show the following data specific to this challenge:
    • Title
    • Teaser
    • Description
    • Details and Official Rules
    • Challenge Finalists (5 design ID #s) - Selected by staff members (if after submission end date).
    • Challenge Winners (5 design ID #s) - Selected by website members (if after voting end date).
    • Challenge Submission Start Date - The date upon which the challenge begins.
    • Challenge Submission End Date - The date upon which design submissions will no longer be accepted.
    • Challenge Voting Start Date - The date upon which members may begin voting on designs entered in this challenge.
    • Challenge Voting End Date - The date upon which vote submissions for designs entered in this challenge will no longer be accepted.
  • A link to view all designs that have been entered in this challenge.
  • If the challenge design submission period is open, the challenge landing page will
    • show the 4 most recent design submissions
    • show the 4 most liked design submissions
  • If the challenge voting period is open, the challenge landing page will
    • show the 5 selected designs
    • allow the logged-in website member to vote on their preferred design
  • If the challenge voting period is over
    • Display the 5 challenge winners and runners up.

• Badges
  • Badges will be earned by design contest winners.
  • Once the challenge is over, an admin must visit the challenge admin page and click the button "Award Challenge Badges". This will automatically send out 1 or more of the following badges to challenge winners and runners up:
    • Champion of the Collective
    • Hero of the Collective
    • Laudable Contributor

Challenges (V1 - Before February 2010)

• A challenge is a competition to which users may submit their designs.
• Only 1 challenge can be considered the current challenge.
• Challenges have 3 dates associated with them:
  • Start Date - The date at which the challenge begins.
  • End Date - The date at which design submissions will no longer be accepted.
  • Voting End Date - The date at which vote submissions for designs will no longer be accepted, and the challenge will be considered over.
• The design challenge will be won by the design that has accrued the most number of votes from the Start Date to the Voting End Date.
  • Admins have the capability of overriding the typical design challenge winner in the Challenge Admin page.
  • Admins may enter the Design Challenge winner, runner-up and up to 3 honorable mentions in the Design Challenge Admin page.
  • Once the Admin submits the design challenge winners, the appropriate design badges will be sent out at that time.
• A user must be logged-in to the site in order to vote on a design.
• Users of the site may vote
  • on any design that has been entered in a challenge.
  • on any design that has been submitted to the current challenge.
  • once on each design.
• Users may not revoke their vote once they have submitted their vote.
• Admins may manually remove a design from a challenge in the Design Admin page.
• The Design Challenge Admin page is available at: http://creative.mozilla.org/admin/challenges

Designs

• A user must be logged-in to add a design.
• The logged-in user must be the design owner in order to edit that design.
• In order to be a valid design, the design must have a Status = 1 and must be owned by a user who has a Status = 1.
• The site visitor must be logged-in to view the full-sized view of the image.
• A license must be selected when adding/editing a design.
• Designs can be edited by admins at http://creative.mozilla.com/admin/designs
• If a user is removed from the site, any designs they submitted will no longer appear on the site.
• A user has to be logged-in to view the full design (/designs/{design_id}/full).

Design Comments

• Design comments may be edited at http://creative.mozilla.com/admin/designs . Load a design, then click the comments link at the bottom of the design edit page in order to edit the design comments.
• Set the comment's status to 0 to remove from the site.
• If a user is removed from the site, any design comments they submitted will no longer appear on the site.

Design Images

• A Design must have a title and an image in order to be added to the site.
• Design images are currently being stored outside of subversion.
• When uploaded, image files are being saved in ~/files/images/designs/{x}/{design_id}/{design_id}_{image_size}.jpg
  • Round the design_id down to the nearest multiple of 1000 to find x. For design_id of 49, x = 0. For design_id of 1049, x = 1000. For design_id of 2049, x = 2000.
  • Image size are:
    • 'th' = Thumbnail, Scaled then Cropped - 123 x 123
    • 'ft' = Feature, Cropped from Large - 280 x 150
    • 'lg' = Large, Aspect Ratio Preserved - 580 x ?
    • 'or' = Original, Aspect Ratio Preserved - ? x ?
• Current upload limit is 8MB.
• Accepted image types are .jpg, .gif and .png

Flags

• Any logged-in user may flag a design, a design comment, or a user.
• Flags may be acknowledged and acted upon at http://creative.mozilla.com/admin/flags

Licenses

• Licenses can be added and edited by admins at http://creative.mozilla.com/admin/licenses
• License images can only be added in the codebase.

Tags

• Tags support characters a-z A-Z and 0-9.
• Spaces, punctuation and all other unsupported characters will be removed when a user adds tags.
• Tags may be from 1 character to 24 characters in length.
• Double quotation marks must be used to add a single tag containing multiple words.
• Adding the tags `red blue "primary colors"` will result in 3 tags being added: `red`, `blue` and `primarycolors`.
• There was talk of limiting users to a specific number of tags for each of their designs. This has not been implemented yet - a specific number should be decided on if this is the case. To help deter a user from adding 100 tags for their design, a maxlength of 128 characters has been added to tag input fields.
• Admins may remove tags from individual designs via the Design Admin page.

Users

• Username supports characters a-z A-Z 0-9 and "_".
• All uppercase characters found within the username will be converted to lowercase characters upon account creation.
• Username must be between 4-32 characters in length.
• Username must be unique; another user on the site cannot have that same Username.
• Passwords must be between 6-42 characters in length.
• Email address must be unique - another user on the site cannot have that email address.
• Verified will be set to 0 if the user has not verified their email address.
• All users who have not verified their email address within 24 hours will be deleted. Garbage collection happens randomly through the Auth Verification model.
• User Status will be set to 1 if the user has any associated login roles. User Status will be set to 0 if the user does not have any associated login roles.
• In order to login, user must have a Verified = 1, Status = 1, and must have an associated login role.
• Users may be designated as site admins through the User admin screen.
• A user cannot voluntary delete their account.
• Users can be edited at http://creative.mozilla.com/admin/users

Site Outline

Base

• /about - About index page
• /contact - Contact Us
• /faq - FAQ
• /toolkit - MCC Toolkit

Account

Account Not Logged-In

• /forgot - Forgot Password
• /login - Login
• /register - Register

Account Logged-In

• /email - Edit Email Address
• /password - Edit Password
• /profile - Edit Profile
• /logout - Logout

Admin

• /admin">Index page</a>
• /admin/badges">Badges</a>
• /admin/designs">Designs</a>
• /admin/designs/3/comments">Design Comments</a>
• /admin/flags">Flags</a>
• /admin/licenses">Licenses</a>
• /admin/users">Users</a>

Badges

• /badges - Browse Badges
• /badges/3/people - Browse all People who have earned a Badge
• /badges/3 - View Badge

Designs

• /designs/add - Add a Design
• /designs - Browse Designs
• /designs/3/edit - Edit a Design
• /designs/3 - View a Design
• /designs/3/full - View the full version of a Design

Fans

• /fans/ryansnyder/people - Browse all People this User is a fan of

Licenses

• /licenses - Browse Licenses
• /licenses/1 - View a License

People

• /people/ryansnyder/designs - Browse Designs uploaded by a User
• /people/ryansnyder/fans - Browse Fans of a User
• /people/ryansnyder/likes - Browse all of the Designs that this user has liked
• /people - Browse People
• /people/ryansnyder - View a Person

Tags

• /tags - Browse all Tags
• /tags/food/designs - Browse all Designs associated with a Tag