carpentries-incubator / fair-research-software

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software
https://carpentries-incubator.github.io/fair-research-software/
Other
8 stars 4 forks source link

update alt-text for 00-introduction #73

Closed zkamvar closed 3 weeks ago

zkamvar commented 3 weeks ago

The two images in the introduction had alt text, but they did not accurately describe the images for screen readers.

I've added alt text that will give screen reader users a better understanding of what the images depict.

github-actions[bot] commented 3 weeks ago

Thank you!

Thank you for your pull request :smiley:

:robot: 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:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-73

The following changes were observed in the rendered markdown documents:

 00-introduction.md | 4 ++--
 md5sum.txt         | 2 +-
 2 files changed, 3 insertions(+), 3 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.

:stopwatch: Updated at 2024-06-25 13:25:14 +0000

zkamvar commented 3 weeks ago

I am never sure what to put for alt-text. Think I need some guidance on this - and others I expect as well.

No worries! It takes practice and that's why I put a callout in the Workbench Lesson: https://carpentries.github.io/sandpaper-docs/episodes.html#accessibility-point-alternative-text-aka-alt-text with a link to a slightly longer tutorial: https://axesslab.com/alt-texts/