Mattermost Asset Guidelines

The following guidelines are intended to help queue and prepare marketing assets for community projects by the Mattermost core committers and the Mattermost community.

Queuing Assets for New Community Projects

Follow these steps to queue an asset for a new community project.

Integrations and Installers

If you find a new integration or installer in the Mattermost Facebook page, Mattermost Twitter page, GitHub or elsewhere you feel Mattermost should promote:

  1. Post a request to the Contributors team “Integrations and Apps” channel with:
  • mention to @jason

  • link to suggested integration

  • link to creator’s GitHub profile, if applicable

    Example:

    @jason Here is [Matterbridge](https://github.com/42wim/matterbridge) from [42wim](https://github.com/42wim), which is a sample bridge between Mattermost, IRC, XMPP, Gitter and Slack.
    
    Is this something Mattermost would like to promote?
    
  1. If the proposal is accepted, Ops reaches out to the integration creator by opening a GitHub issue with the following text:

    Title:
    
    Share your work with Mattermost community?
    
    Body:
    
    Hi @{GitHub_username},
    
    We came across your work and we'd love to help share it with the Mattermost community.
    
    If this interests you, we wondered if you'd help complete a form to tell us more about your work so we can promote it?
    
    Here's the form: https://spinpunch.wufoo.com/forms/mattermost-integrations-and-installers/
    
    We'd also like to welcome you to join our public integrations community channel on our nightly build server: https://pre-release.mattermost.com/core/channels/integrations
    
    Thanks for being a valued member of the Mattermost Community!
    
    - The Mattermost Team
    
  2. When a contributor submits an integration via the Wufoo form, a Zapier webhook posts relevant information into the Integrations and Apps channel.

  3. Ops replies to each new Wufoo post with a numbered project title and project status. Example:

    #### 64) Cloud Foundry Integration (work queued)
    

Media Articles

When a relevant article on Mattermost is found in the news, add a new entry into this Google document and follow the process specified there.

Step-by-Step Asset Creation Guide for Artists

Follow these steps to create an asset for integration or feature promotion, integration blog tweet, or user award tweet.

You can find sample templates for integration promotions, guest blog posts and feature promotion in this Google drive.

Integration or Feature Promotion

  1. Use this template as a starting point.
  2. Change text in the “copy - title” layer following the guidelines in Feature Title.
  3. Change text in the “by Galois, Inc.” layer to replace the name with appropriate creator name following the guidelines in Feature Creator.
  4. Change the contents of the “featured image” folder to update representative art following the guidelines in Feature Representative Art.
  5. Replace the “logo - matterhorn” layer to update representative logo(s) following the guidelines in Mattermost and Representative Logos.
  6. Save the finished asset draft in both .TIF and .PNG format, and upload to your “Dropbox Share” folder.

Integration Blog

These guidelines are out of date and should be updated for the new banner design

Occasionally a blog post will be written to further promote an integration. Follow these steps to create a marketing asset promoting said blog entry:

  1. Use this template as a starting point.
  2. Change text in the “title” layer to read “Meet the Creator:”, followed by the proper integration name.
  3. Change text in the “by liger1978” layer to the integration creator’s name.
  4. Change the contents in the “right image” layer to include proper representative logo, followed by a split with the blue Mattermost logo. This helps create the message that it’s the representative and Mattermost together.
  5. Obtain a photo of the integration creator, apply a Wall Street Journal “Hedcut” effect, and update the “Left Image” layer. A helpful tutorial for how to achieve the “Hedcut” effect can be found here.
  6. Save the finished asset draft in both .TIF and .PNG format, and upload to your “Dropbox Share” folder.

User Award

These guidelines are out of date and should be updated for the new banner design

Occasionally a blog post will be written to recognize a member for their contributions to Mattermost. Follow these steps to create a marketing asset promoting said blog entry:

  1. Use this template as a starting point
  2. Change text in the “title” layer to update the user being recognized, the event, and contribution or integration made
  3. Change the contents in the “right image” layer to include proper representative logo and/or a picture of the user being recognized
  4. Change the contents of the “Left Image” layer to update text with proper event name and match color to logo in the right pane
  5. Save the finished asset draft in both .TIF and .PNG format, and upload to your “Dropbox Share” folder

Asset Elements

The following include guidelines for specific elements of an asset.

Feature Title

  1. Appears in the top left corner of the asset
  2. Title should “communicate the benefit” of the work, while referencing its name, followed by “for Mattermost”
  • Sometimes the title is a straightforward description of an app that can now connect to Mattermost, like “Jira integration for Mattermost”
  • Sometimes the title needs to be non-standard, like “Gitter integration for Mattermost via Matterbridge”
  1. Title should always be title case
  2. Short titles are better than longer titles

Feature Creator

  1. Appears in the bottom right corner of the asset footer
  2. Text in footer should use GitHub username in lowercase, or company/person name in capital case i.e. by matterhorn-chat or by Galois, Inc.
  3. When the background is blue, the footer should be black. When the background is white, the footer should be blue.
  4. Displays who created the integration (Twitter or GitHub account of the creator)
  5. If text doesn’t blend well with left pane representative art, adjust the outer glow effect

Feature Representative Art

  1. Representative art appears in the right side of the asset
  2. Screenshot of a feature in action is most preferred (see guidelines for Feature Screenshot here)
  3. If no feature screenshot is available, take a screenshot of a well-formatted “README” file or of feature code with the word “Mattermost”
  • If using a “README” file, ensure the screenshot doesn’t highlight spelling or capitalization errors
  1. Change the color of the background based on the color of the screenshot. If the screenshot is light, use a dark background. If screengrab is dark, use a light background.
  2. Screenshot should not take up more than 40% of the banner width.
  • Ensure there is around 31px of “white space” between the content of the screengrab and the edge of the screengrab. (This can be adjusted by resizing the rectangle layer below the screengrab in Photoshop)
  • Ensure there is at least 64px of width between the copy title and the edge of the screengrab.
  • There should be around 60px of space between the top edge of the screengrab and top edge of the banner. (Give or take 10px considering the diagonal of the screengrab)
  1. Leave equal whitespace between all like objects
  2. Avoid wavy lines when rotating an image as shown in the sample below
../_images/asset-guidelines-wavy-lines.png
  • To avoid them, increase the size of the original layer, rotate it, then reduce the size of the image
  1. Adjacent areas of light and dark should always have a separator, or have a shading so that the areas don’t bleed into the background
  2. If a logo is used, ensure it follows the same guidelines from Mattermost and Representative Logos section

Feature Screenshot

When taking a screenshot of a feature, follow these guidelines:

  1. Complete: Profile pictures and real people names should be filled out. Use either in-house art, free or purchased clip art. If you’re modifying the image such as changing username and profile picture, make sure to do it throughout the image. Don’t show any bugs or UX defects in the product and use the “Mattermost” theme when appropriate.
  2. Authentic: Try to model a real world interaction. When possible, highlight DevOps use cases since they are familiar to the majority of our users.
  3. Oversized: Provide screenshots that are at least 20-30% larger than needed, so that there’s room to rotate and crop the image as needed
  4. Illustrative: Try to find screenshots that are representative of the feature
  5. Easy to follow: The screenshot should be easy to understand at a glance. Avoid using short forms or acronyms in conversations, and choose images that are clear

Mattermost and Representative Logos

  1. Mattermost logo appears in the bottom left corner of the asset
  2. Use white Mattermost logo on dark backgrounds and black Mattermost logo on light backgrounds.
  3. Representative logo appears on the left side of the asset below the feature title
  4. When the background color is dark, use the white/inverted version of company logo. When the background color is light, use the dark/primary version of company logo.

Step-by-Step Asset Review Guide for Ops

  1. Upload the artists “work in progress” files to the Archive Dropbox sub-folder in Twitter Marketing
  2. In the Contributors team, find the appropriate conversation thread for the queued project, and add a comment mentioning @jason with the following:
  • Link to the image in Dropbox
  • Proposed tweet text with a note to specify whether or not the mention in the text is the Twitter handle of the user.
    • @username is the Twitter account of the GitHub user if the text uses a Twitter username, or
    • @username is NOT the Twitter account of GitHub user if the text doesn’t use a Twitter username
  • Proposed scheduled tweet date
    • Never schedule a tweet for the 16th or 22nd of any given month as these days are reserved for Mattermost and GitLab release announcements, respectively
  • .png version of the file for a quick preview