docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Document visual accommodation best practices & guidelines for selecting or customizing Mattermost client themes

Open cwarnermm opened this issue 3 years ago • 0 comments
trafficstars

Problem space Mattermost supports the ability for all users to customize the look of their Mattermost client by applying a theme. Mattermost ships with a number of standard client themes, and supports the ability for users to create their own custom themes from scratch.

Mattermost users visiting the product documentation to learn about pre-built and custom themes would benefit from recommendations and guidance targeted for visual accessibility accommodations.

One example of visual accommodation includes colour blindness:

  • Deuteranomaly is a type of red-green colour blindness that makes green things look more red.
  • Protanomaly makes red things look more green and less bright.
  • Protanopia and deuteranopia both make it challenging to tell the difference between red and green things.

Questions to consider

  • Which Mattermost themes are best suited for specific visual accommodations?
  • Are there specific built-in theme recommendations for visitors that would improve their Mattermost client experience based on the accommodation needed?
  • Is there specific custom theme guidance we can provide to users who want to create their own custom theme that accommodates for specific visual conditions?

Target audience All users

Goal

  • Update the Customize your Mattermost theme end user documentation for Mattermost Channels to include built-in theme recommendations where applicable for documentation visitors looking for visual accommodations.
  • Update this same documentation to include custom theme recommendations for documentation visitors looking for visual accommodations.

Delivery expectations

  • 1 PR per Channels end user documentation page
  • This ticket is best suited for one or more contributors who have a working knowledge or experience with supporting visual accommodation, such as colour blindness.
  • Comment in the PR to request a generated preview of your work. The Docs team will add the appropriate labels to your PR.

Tech needed

  • Sphinx
  • RST format
  • Mattermost Channels functionality

Affected repository mattermost/docs

Where to get help Join the Mattermost Docs team on the Mattermost Community Server in the ~Documentation Working Group channel to discuss this ticket, or feel free to comment in this docs ticket

cwarnermm avatar Oct 07 '22 18:10 cwarnermm