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

Add descriptive alt text to all images #988

Merged
merged 2 commits into from
Jun 20, 2024

Conversation

multimeric
Copy link
Contributor

My sense is that some of the current image alt texts are not descriptive enough. For example "The Git Commit Workflow" is more of a title than a description. I have generally attempted to follow the following principles: https://carpentries.org/blog/2022/11/accathon/.

Copy link

github-actions bot commented Apr 17, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-988

The following changes were observed in the rendered markdown documents:

 01-basics.md               |  8 +++-----
 03-create.md               |  4 +---
 04-changes.md              |  6 ++----
 05-history.md              |  6 ++----
 07-github.md               | 18 ++++++++----------
 08-collab.md               |  6 ++----
 09-conflict.md             |  4 +---
 14-supplemental-rstudio.md | 14 ++++++--------
 md5sum.txt                 | 16 ++++++++--------
 9 files changed, 33 insertions(+), 49 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-05-28 12:00:11 +0000

@pgmccann
Copy link
Contributor

I like these, and think they are generally a big improvement, but I have a concern about the accessibility of text which references "the previous/earlier diagram". I believe it is generally not good practice to refer to an element of a webpage by its position alone.

@martinosorb
Copy link
Contributor

Thank you for the PR @multimeric. If you can think of a meaninful way to change your alt texts according to @pgmccann's comment, that would be great. Otherwise I will merge as-is, which is already a clear improvement.

github-actions bot pushed a commit that referenced this pull request May 2, 2024
@multimeric
Copy link
Contributor Author

Okay, I'll try to think about how I might explain these diagrams without referring to earlier diagrams, but I think it might end up being quite verbose.

@martinosorb
Copy link
Contributor

Thank you @multimeric.
@kekoziar I will merge unless you have objections.

github-actions bot pushed a commit that referenced this pull request May 28, 2024
@multimeric
Copy link
Contributor Author

Sure, this is all good from my end.

@martinosorb martinosorb merged commit 4243a54 into swcarpentry:main Jun 20, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 20, 2024
Auto-generated via {sandpaper}
Source  : 4243a54
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2024-06-20 14:53:14 +0000
Message : Merge pull request #988 from multimeric/alt-text

Add descriptive alt text to all images
github-actions bot pushed a commit that referenced this pull request Jun 20, 2024
Auto-generated via {sandpaper}
Source  : 75d6a34
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-20 14:54:01 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4243a54
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2024-06-20 14:53:14 +0000
Message : Merge pull request #988 from multimeric/alt-text

Add descriptive alt text to all images
github-actions bot pushed a commit that referenced this pull request Jun 25, 2024
Auto-generated via {sandpaper}
Source  : 75d6a34
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-20 14:54:01 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4243a54
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2024-06-20 14:53:14 +0000
Message : Merge pull request #988 from multimeric/alt-text

Add descriptive alt text to all images
github-actions bot pushed a commit that referenced this pull request Jun 28, 2024
Auto-generated via {sandpaper}
Source  : 75d6a34
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-06-20 14:54:01 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 4243a54
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2024-06-20 14:53:14 +0000
Message : Merge pull request #988 from multimeric/alt-text

Add descriptive alt text to all images
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants