OpenLiberty / OpenLiberty/docs
Accessibility: JAWS, manual, Chrome extension checking
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
Generally, the documentation needs to be tested and accessibility violations fixed. At least some would likely need to be fixed by the open liberty site team.
JAWS testing of just a few topics pointed out issues:
For code snippets, a copy button that JAWS can read needs to be on each code snippet.
- Instead of a button, it is a graphic. Make it a button.
- JAWS can read the graphic only on the first code snippet, not on the ones that follow.
The problem can be seen in the following two topics.-
Log and trace configuration: https://openliberty.io/docs/latest/log-trace-configuration.html?_ga=2.138938227.1100166455.1663769468-1172611259.1588265214#rollover
-
HTTP Access logging: https://openliberty.io/docs/latest/access-logging.html?_ga=2.138938227.1100166455.1663769468-1172611259.1588265214#_time_based_http_access_log_rollover
- Another problem with this topic is that "Settings for a common log" and "Settings for distinct logs for each endpoint" read more like subheadings, but they are coded as list items.
Using the Accessibility Checker Chrome extension in the OpenLiberty.io framework, violations with color contrast, possibly with the version selector, problems tabable elements.
-
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Log and trace configuration and HTTP Access logging topics linked in the issue, testing them with JAWS and the Accessibility Checker Chrome extension. Review the reported code-snippet controls, heading/list semantics, color contrast, and tabable elements; done means the violations are fixed or site-team dependencies are clearly identified.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100