microsoft / microsoft/Dynamics-365-FastTrack-Implementation-Assets

Animated GIFs throughout documentation

Open
#350 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
494
Forks
296
Avg merge
1d 10h
Merged PRs (30d)
5

Description

Please stop using animated GIFs that automatically play in documentation. These are insanely distracting and make reading the nearby text virtually impossible for many of us. Post multiple screenshots if you can't capture everything you need to in a single picture. If you must post a short video, give the reader a way to pause playback (or just provide a link to a video instead). A 1-second delay between images is extremely difficult to absorb for screens with any significant complexity.

For example, from the Fabric workshop at https://github.com/microsoft/Dynamics-365-FastTrack-Implementation-Assets/tree/master/Analytics/DataverseLink/FabricWorkshop , these are the types of GIFs I'm referring to:
https://github.com/microsoft/Dynamics-365-FastTrack-Implementation-Assets/blob/master/Analytics/DataverseLink/FabricWorkshop/media/image6.gif
https://github.com/microsoft/Dynamics-365-FastTrack-Implementation-Assets/blob/master/Analytics/DataverseLink/FabricWorkshop/media/image14.gif
https://raw.githubusercontent.com/microsoft/Dynamics-365-FastTrack-Implementation-Assets/master/Analytics/DataverseLink/FabricWorkshop/media/image19.gif
https://raw.githubusercontent.com/microsoft/Dynamics-365-FastTrack-Implementation-Assets/master/Analytics/DataverseLink/FabricWorkshop/media/image20.gif

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying animated GIFs throughout the repository documentation, then inspect the example media files image6.gif, image14.gif, image19.gif, and image20.gif from the linked Fabric workshop. Replace distracting auto-playing media with multiple screenshots or a pausable or linked video, and confirm that the documentation no longer uses unpausable animated GIFs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.