Improve accessibility with image alternative text

[ksuess]

Criteria to close this issue.

• Search for {figure} and {image} and get count of instances (326). Compare against count of :alt: (128). Add meaningful alt attributes.

• Document that alt values are required in docs/contributing/markup-syntax.md. Currently we have only an example without stating that alt is required.

• Add an explanation or reference to the same page. For example:

  Why use an alt tag?

  • improves SEO: https://duckduckgo.com/?q=plone+training&atb=v85-1&iax=images&ia=images
  • Alt text is displayed in case the image does not load.
  • Accessibility is part of the Plone brand and identity

• Create a script or find a tool that automatically finds all images and figures with missing alt attributes, and optionally uses AI to suggest a value for the documentation author to edit. Absolutely do NOT trust AI to do it automatically for you. This would be on the author's local development environment.

• Find or create a GitHub app or workflow that checks documentation for accessibility, is configurable, and reports any configured issues.

[ksuess]

This is a job to do: adding alt attributes in existing docu.

After this is done I would vote for documenting alt attribute as required and add a check.

[stevepiercy]

Is there an easy way to automate checking images for alt text in GitHub Actions or Sphinx?

[stevepiercy]

@ksuess Why did you close this? It is not complete.

[Sneha-Goswami123]

Hi, I’d like to work on this issue.
Please let me know if it’s okay to proceed and if you have any guidance.

[stevepiercy]

@Sneha-Goswami123 thanks for asking, but you don't need permission to work on open source software, especially in Plone. However, we do have general guidance.

Please read and follow First-time contributors, especially Things not to do, Contributing to Plone, and Contribute to documentation.

I also edited the issue description to have closing criteria.