Design/CreativeCollective/Docs

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

Badges

• A badge is an award that a user may earn for interacting 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.com/admin/badges
• User badges can be revoked through the User Admin page.

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.
• Designs can be edited by admins at http://creative.mozilla.com/admin/designs

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.

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.
• Images are currently being saved, with all but Square maintaining aspect ratio, as:
  • 'sq' = Square = 75 x 75
  • 'th' = Thumbnail = 100 x ?
  • 'sm' = Small = 240 x ?
  • 'md' = Medium = 640 x ?
  • 'lg' = Large = 1024 x ?
  • 'or' = Original size
• 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

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.
• 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.
• There is no admin page for tags.

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 5-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

Needed from Others

• Text
  • Footer links
    • Twitter - http://twitter.com/MozCreative
    • Mailing List - https://mail.mozilla.org/listinfo/design
  • Page Text
    • Text for About page at /about - https://wiki.mozilla.org/File:About_Us_copy.png
    • Text for FAQ page at /about/faq
    • Text for Policies/Terms page at /about/terms
    • Text for Toolkit page
    • Text for Contact Us page - https://wiki.mozilla.org/File:Contact_Us.png
  • Email Text- https://wiki.mozilla.org/Design/CreativeCollective/Edits#AUTOMATIC.C2.A0EMAIL.C2.A0CONTENT
    
    • Forgot password - check
      
    • Change email - check
      
    • Registration - check
      
    • Welcome - check
      
    • Badge notification email - Congratulations!...
    • Design Comment notification email - so and so has commented...(ask WebDev)
    • Fan notification email - so and so has become a fan...
• Admin panel
  • Badges
    • Edit badges text in the admin panel
  • Licenses
    • Add licenses that are missing through the admin panel
    • Edit licenses text in the admin panel
  • Users
    • Designate appropriate users as admins in the User Admin screen.