Help Wanted: Identify developer documentation content that would benefit from visual assets to supplement existing written content

[cwarnermm]

Problem space
In the Mattermost Developer Documentation, there is content that is currently text-heavy. This text-heavy content is beneficial to visitors who learn well by reading, but is less beneficial to visual, audio, or kinaesthetic learners.

Target audience
All users

Goal

• Identify content across the developer documentation site that would benefit from the addition of visual elements, such as animated GIFs, embedded videos, workflow diagrams, or static screenshots to supplement existing material.
• Design, develop, record, or capture the visual asset and incorporate it on the documentation page.

Delivery expectations

• 1 PR per documentation page that would benefit from visual elements
• Visual elements introduce new maintenance effort going forward, so please ensure that visual elements add good value to the target audience
• All visual elements featuring Mattermost product interfaces must use the default Denim theme. Please do not create visual assets featuring Mattermost clients using a custom theme or any other theme other than Denim. This is to ensure that all product imagery across the documentation site remains consistent.
• 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

• Hugo
• Markdown format
• Mattermost product functionality
• screen capture or recording software

Affected repository
mattermost/mattermost-developer-documentation

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

[Drishti-jain21]

Hi, I feel we can summarise the You've found a bug under Why and How to Contribute into a workflow diagram. It will be easier for the user to go through it
I would like to work on this issue

[cwarnermm]

Thank you, @Drishti-jain21! I'm looking forward to seeing what you come up with, and I've assigned you to this ticket.

[cwarnermm]

Please note that additional contributors can be assigned to this ticket. Please don't hesitate to speak up if you'd also like to work on this issue.

[Drishti-jain21]

Hi @cwarnermm I am done with the workflow diagrams.
Where do I add them in the repository?

[cwarnermm]

Hi @Drishti-jain21! Good question!

The easiest way to identify the source file you need to update is by:

1. Navigating to the documentation page you want to edit.
2. Selecting the Edit on GitHub option located in the top-right corner of the published docs page.

This takes you directly to the source file you want to update.