OpenLiberty / OpenLiberty/docs

Accessibility: JAWS, manual, Chrome extension checking

Open
#5,827 2 comments 0 reactions 0 assignees View on GitHub

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.