antsibull-docs
antsibull-docs copied to clipboard
ansible-community
accessibility feedback on module tables
From a recent reddit post asking users to evaluate the new tables using the following two links:
https://docs.ansible.com/ansible/devel/collections/community/crypto/acme_certificate_module.html#parameters and https://docs.ansible.com/ansible/devel/collections/community/hashi_vault/hashi_vault_lookup.html#parameters.
I sometimes need to use a screen reader and access these docs using lynx. Here are a few observations :-
When I browse to either link with lynx I get a "bad HTML" message.
It renders anyway but the warning possibly ought to be fixed. I suggest you validate here:- https://validator.w3.org/nu/?doc=https%3A%2F%2Fdocs.ansible.com%2Fansible%2Fdevel%2Fcollections%2Fcommunity%2Fcrypto%2Facme_certificate_module.html against the wc3 standards.
I also tried with links and that didn't display an error.
Next test was actually using the page with a screen reader. It was a bit of a problem because the text structure inside the tables is very confusing when read aloud.
Lastly and this one is really minor, the little 'permalink' symbol you use for linking doesn't have a character in the font on my terminal so it renders as a ? in a box.
When I bring the page up in Firefox and use the screen reader, for some reason the tables don't get read out at all. I get told which cell of the table I am in but not what the content is.
These problems existed prior to the new rst based tables so nothing introduced by that feature, fwiw.
The broken HTML (at least the part caused by antsibull, if there are errors left they are probably caused by the theme) should be fixed by ansible-community/antsibull#387.
https://github.com/ansible-community/sphinx_ansible_theme/pull/44 and https://github.com/ansible-community/sphinx_ansible_theme/pull/45 fix/improve some of the issues in the theme.
https://github.com/ansible/ansible/pull/76759 bumps antsibull to 0.40.2 for the docs build, and ansible-community/antsibull#388 should prevent invalid HTML in the future.
I don't have a screen reader, so I cannot really look at the screen reader issues...