docs
docs copied to clipboard
mattermost
Help Wanted: Keep product images up-to-date
Context
Screenshots and animated GIFs are great tools for visual learners. But they're only as great as they are current and up-to-date. Old screenshots introduce friction and confusion.
Docs request
See a product screenshot that's outdated? Help us keep them updated and featuring the latest product interface!
- Update the docs page with new product screenshots in PNG format.
- Review the docs and GitHub code for any other instances of these specific screenshots being outdated.
- Ensure that ALT text is updated as needed.
How you can help
- Ensure you're using the latest version of Mattermost. You're welcome to base your screenshots off of the Mattermost Community Server UI.
- Use the Desktop App, the standard Mattermost Denim theme, and US English for all official docs screenshots (Unless you're specifically creating a screenshot for the mobile app).
- Don't draw arrows, lines, or call outs on screenshot images.
- Replace existing screenshot filenames via
/images.
Hi @ayrotideysarkar! Absolutely! You're welcome to choose where you'd like to start.
I'd like to help with this too! Also I've added images to a page in a fork of the repo, is there a way I can preview it as a webpage before creating a merge request?
Thanks, @TheOne04! All contributions are welcome. Please coordinate with @ayrotideysarkar directly to avoid effort duplication :)
To generate a preview of your changes, you can add the preview-environment label to your docs PR. That label should kick off a build of the docs you can preview, and once the build is complete, you'll see a link in your docs PR to that preview instance.
Alternatively, you can build the docs locally. See the docs README for details on setting up your local development environment.
@cwarnermm I am not actively working on it now...sorry for replying late.
Sorry for the late reply, I haven't been as active lately, but I'll try to add a couple of new screenshots in the next week. Thanks for your patience!
@cwarnermm Actually due to current commitments I won't be able to address this for some time :( , I'll try to revisit when I have time. Appreciate your understanding!
Inside images folder nothing is organized, Everything is mashed up.
Amm, as I thing organising images is more important, it will be more professional and also helpful in future tasks.
This ticket is requesting that old screenshot images across the docs site are re-captured to reflect the user's current product or third-party tool experience. Let me know if you're open to taking on this ticket as-is.
While I agree that organizing image files is generally a good idea, doing so at this time would also necessitate documentation source code updates to ensure the new image file paths are correct, which is beyond the scope of this docs issue. If this is something you feel passionate about, @yesbhautik, I am open to supporting such an initiative with a separate issue.
Hi @cwarnermm, here is the sheet for tracking the updation of images, GIFs, and videos throughout the Mattermost documentation.
Please let me know in case you have any feedback.
Thank you, @chessmadridista! Really appreciate your systematic approach to this problem space!
When tracking image assets across the docs site, tracking the source file is higher priority than tracking the page title - both from a tracing perspective and a file type perspective (the docs site contains both RST and MD files).
In addition, not sure we need to track via column J (has everything been updated) since previous columns track assets by type. Thoughts?
Thank you, @chessmadridista! Really appreciate your systematic approach to this problem space!
When tracking image assets across the docs site, tracking the source file is higher priority than tracking the page title - both from a tracing perspective and a file type perspective (the docs site contains both RST and MD files).
In addition, not sure we need to track via column J (has everything been updated) since previous columns track assets by type. Thoughts?
Hi @cwarnermm, I have changed the column name.
For column J, I included it because it will make it easier for the eyes to track all the changes at once. I tend to be verbose in these types of things, for clarity related to the overall status of the tasks and to speed things up. I have removed the respective column in the other sheet. Would you like me to remove it in this one as well?