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

Automatically ensure all images have an alt tag when publishing to WordPress Documentation #1473

Open
1 task
flexseth opened this issue Feb 27, 2024 · 4 comments
Assignees
Labels

Comments

@flexseth
Copy link
Collaborator

Issue Description

When contributing code to the WordPress Core codebase, there are automated GitHub actions that check for missing alt tags on images. However, there is no associated action when contributing to documentation.

When writing docs it is imperative to account for accessibility.

In lieu of having to manually check every post before publishing, is it possible to create a GitHub action that will run and make sure all images have alt tags?

URL of the Page with the Issue

During Contributor Day in the February 2024 Mentorship Cohort, I came across
#1284 - High Priority, but low-hanging fruit issue for WordPress 6.4

@zzap - to close the ticket above I'm going to double check the links on this page for alt tags and comment that it can be closed.

Section of Page with the issue

Every submitted documentation page. HelpHub, DocHub, etc.

Where all the docs live.

This issue will be persistent if the docs contributor does not include an alt tag when adding images into docs. Contributor onboarding sample use case:
Check Block pattern docs for alt tags

Why is this a problem?

Images will be available in most docs, so we will need to always check docs for accessibility (manually for now)

Suggested Fix

  • Write a GitHub action to check docs page before publishing.

If there are not alt tags in all images, automatically request this be fixed.

Allows for realtime review of documentations for accessibility best practices.

@flexseth flexseth added the [Status] To do Issue marked as Todo label Feb 27, 2024
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@flexseth
Copy link
Collaborator Author

Accessibility bot to the rescue?

@flexseth
Copy link
Collaborator Author

/assign

Copy link

Hey @flexseth, thanks for your interest in this issue! 🍪🍪🍪
If you have any questions, do not hesitate to ask them in our #docs Slack channel.
Enjoy and happy contributing ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 participant