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

docs: add accessibility section to plugins guide #7277

Merged
merged 6 commits into from
Feb 8, 2022

Conversation

Malvoz
Copy link
Member

@Malvoz Malvoz commented Sep 15, 2020

Increase awareness and advocate for accessible content from plugin authors.

@Malvoz Malvoz changed the title docs: add accessibility section docs: add accessibility section to plugins guide Sep 15, 2020
@johnd0e johnd0e added the accessibility Anything related to ensuring no barriers exist that prevent interactions or information access label Sep 16, 2020
@johnd0e johnd0e added the docs Improvements or additions to documentation label Sep 19, 2020
@Malvoz
Copy link
Member Author

Malvoz commented Nov 14, 2021

May I ask for a review of this PR? 🙏🏼

Copy link
Member

@Falke-Design Falke-Design left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see no problems with adding this to the documentation.
For me personally: The links are very "hard to read" and I don't think that a new plugin contributer will read through it. It would be good if there would be a list of common mistakes (specially for Leaflet) and / or maybe a link to a docu which explains the first steps and the important information about this topic. Do you understand what I mean?

Apart from this PR, would you have the time to create PRs for each accessibility issue? If not it would be very helpful if you can write into the issues what should be changed (from this into this), then we create PRs

@Malvoz
Copy link
Member Author

Malvoz commented Nov 14, 2021

Thanks for the feedback @Falke-Design.

For me personally: The links are very "hard to read" and I don't think that a new plugin contributer will read through it.

Those documents are authoritative and are often referred to in the accessibility dev world, but they may take some time getting used to. I don't expect developers to read it all, but more so for them to know that they're there, and that they mean something. And they can choose to use them (and learn how to use them) if they wish. Perhaps they should be replaced with- or accompanied by e.g.:

That second resource even covers what we're discussing here 😋:

Standards can be complex and hard to read, and therefore are often only referenced as a last resort. I'd argue that they should be consulted first. They are the most authorative source of how things should work.

(https://github.com/mfairchild365/a11y-resources#standards)

It would be good if there would be a list of common mistakes (specially for Leaflet)

I did consider that, but how many would be enough, or too few? Generally the issues in Leaflet and plugins are issues that are common to all web sites. I.e. issues with: focus delegation, focus visibility, missing accessible names (and then I suppose I'd have to explain what an accessible name is and that it may be derived from: text from element/aria-label/title, which those resources would otherwise explain), etc. But these things are generally covered by the testing tools (which I do expect developers to use) or easily discovered during manual testing with a keyboard, and a screen reader (thus I recommended manual testing, and added a list of tools).

@Malvoz
Copy link
Member Author

Malvoz commented Nov 14, 2021

Apart from this PR, would you have the time to create PRs for each accessibility issue? If not it would be very helpful if you can write into the issues what should be changed (from this into this), then we create PRs

I believe each issue should have a proposed solution already. I will try to find time to look over the issues tomorrow to clarify them, perhaps by using headings, such as "Motivation" and "Solution". 👍

@Falke-Design
Copy link
Member

[...] to know that they're there, and that they mean something. And they can choose to use them (and learn how to use them) if they wish

Good point 👍

how many would be enough, or too few? [...] are common to all web sites

Yes I understand. I looked into your links and they have so much informations, that I closed the sites fast again 😉 But you are right there are enough tools out there. And you added already a good list to start.

to look over the issues tomorrow to clarify them

Thanks. I think you have the most experience so it would be good to have clear suggestions and then we can change this in Leaflet 👍

@Malvoz

This comment was marked as off-topic.

@Falke-Design

This comment was marked as off-topic.

@Falke-Design Falke-Design added this to the 1.8 milestone Nov 26, 2021
@Falke-Design Falke-Design modified the milestones: 1.8.0, 1.8.1 Dec 17, 2021
@Malvoz
Copy link
Member Author

Malvoz commented Feb 8, 2022

I think this is a good addition as is, it could be tweaked later if necessary.

@Malvoz Malvoz requested a review from mourner February 8, 2022 11:31
@IvanSanchez IvanSanchez merged commit 0b8ce65 into Leaflet:main Feb 8, 2022
@Malvoz Malvoz deleted the content-accessibility branch February 8, 2022 12:31
@Malvoz Malvoz removed this from the 1.8.1 milestone Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Anything related to ensuring no barriers exist that prevent interactions or information access docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants