All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tim Orling <ticotimo@gmail.com>
To: YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Documentation standard: considerations for accessibility
Date: Mon, 29 Nov 2021 06:22:06 -0800	[thread overview]
Message-ID: <CANx9H-C8xFhYQMJT5thuv6NuQ3nJN49zHAiMGhoQHhcZ=PNtLA@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 1077 bytes --]

I know we have just begun to have some standards for our documentation [1].

As I am preparing the Hands-on Kernel Lab [2] for contribution, it came to
mind that my screen captures of qemu are not helpful to our visually
impaired colleagues using screen readers. I thought I would start this
thread so we can contemplate accessibility as part of our standards.

A quick search led to [3], which as I suspected suggests adding alt-text to
summarize what an image is trying to show. I doubt full-text of the qemu
log would be appropriate, but perhaps calling out the specific lines that
are of interest?

There are other suggestions in [3] about font styling and so on that are a
bit harder to see an easy path forward on. Perhaps an accessible rendering
that skips the fancy styling?

Obviously this is not a well-thought out proposal. I just thought we could
start a conversation.

[1] https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md
[2] https://github.com/moto-timo/yocto-docs/tree/timo/kernel-lab
[3] https://developers.google.com/style/accessibility

[-- Attachment #2: Type: text/html, Size: 1468 bytes --]

                 reply	other threads:[~2021-11-29 14:22 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CANx9H-C8xFhYQMJT5thuv6NuQ3nJN49zHAiMGhoQHhcZ=PNtLA@mail.gmail.com' \
    --to=ticotimo@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.