Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help Wanted: Create animated GIFs for mobile app workflows #6657

Open
cwarnermm opened this issue Sep 26, 2023 · 9 comments
Open

Help Wanted: Create animated GIFs for mobile app workflows #6657

cwarnermm opened this issue Sep 26, 2023 · 9 comments
Labels
Area/Documentation Improvements Improvements to documentation Difficulty/1:Easy Good First Issue Suitable for first-time contributors Help Wanted Community help wanted

Comments

@cwarnermm
Copy link
Member

Context

Visuals and short, animated GIFs can help teach visual learners how to perform tasks using the Mattermost mobile app. Example of a docs page with visuals

Docs request

  • Review all end user product documentation for tasks, features, and outcomes where functionality is missing a visual "show me" element (screenshot or animated GIF). Example of a docs page with both desktop/web and mobile visual gaps.
  • Capture a short animated GIF or a static image of each end user workflow to add inline on the docs page.

How you can help

  • Use the latest Mattermost mobile app and the standard Mattermost Denim theme to capture all workflows.
  • Avoid drawing lines, arrows, boxes, or call outs on images.
  • Don't forget to include ALT Text descriptions for all new image assets.
  • Use existing docs pages with images as a starting point for code guidance. The Docs team can help provide RST syntax support for publication.
  • Save static image files in PNG format within the /images directory in the docs repository.
  • Create a docs PR that adds the visuals to the product documentation.
@cwarnermm cwarnermm added Help Wanted Community help wanted Good First Issue Suitable for first-time contributors Area/Documentation Improvements Improvements to documentation Up for Grabs Difficulty/1:Easy labels Sep 26, 2023
@Asterwl
Copy link

Asterwl commented Oct 2, 2023

Hey @cwarnermm @lindy65 , can i work on this issue ?

@lindy65
Copy link
Contributor

lindy65 commented Oct 2, 2023

Yes sure @Aviraltech - I've assigned you

@cwarnermm
Copy link
Member Author

@Aviraltech - Are you actively working on this ticket?

@Rutam21
Copy link
Contributor

Rutam21 commented Oct 17, 2024

@cwarnermm I believe it would be better if we raise PRs with the new visuals on a per-page basis.
I would like to start with the page that you mentioned in the issue itself.

@cwarnermm
Copy link
Member Author

@Rutam21 - Excellent approach! I'm very open to splitting out the work needed here into individual issues & PRs. Are you open to creating a new issue specific to the page you'd like to start with?

@Rutam21
Copy link
Contributor

Rutam21 commented Oct 17, 2024

Yeah, sure @cwarnermm . I will create a separate issue for that and tag this as the parent issue.

@cwarnermm
Copy link
Member Author

Fantastic! Thank you!

@Rutam21
Copy link
Contributor

Rutam21 commented Nov 6, 2024

Checkpoint 1 Reached

  • The above list of issues mark the work completion for the Collaborate within channels section.
  • All 16 pages inside it are taken care of and visual workflow guides have been added where necessary.

cc: @cwarnermm

@Rutam21
Copy link
Contributor

Rutam21 commented Nov 25, 2024

Checkpoint 2 Reached

  • The above list of issues mark the work completion for the Communicate with messages and threads section.
  • All 9 pages inside it are taken care of and visual workflow guides have been added where necessary.

cc: @cwarnermm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/Documentation Improvements Improvements to documentation Difficulty/1:Easy Good First Issue Suitable for first-time contributors Help Wanted Community help wanted
Projects
None yet
Development

No branches or pull requests

4 participants