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

nbconvert-a11y roadmap #27

Open
5 of 26 tasks
tonyfast opened this issue Dec 29, 2023 · 0 comments
Open
5 of 26 tasks

nbconvert-a11y roadmap #27

tonyfast opened this issue Dec 29, 2023 · 0 comments

Comments

@tonyfast
Copy link
Member

tonyfast commented Dec 29, 2023

this meta-issue is used to generate issues for roadmap items. each checklist item is converted into an issue to track the progress of each efforts. new roadmap items should be added to this to ensure we have a central place to track progress.

nbconvert-a11y intends to be a choke point for accessible developer experiences with open science tools. in 2024, nbconvert-a11y will generate new software, processes, and opportunities that address inaccessibility in open source software.

user testing

the primary inspiration for continued work on nbconvert-a11y is the feedback from affected blind or visually impaired testers. hearing and understanding their experiences is the only way we've been able to develop candidates for assistive technology experiences.

  • BVI user testing for site/notebook navigation
  • BVI user testing for consuming cell inputs
  • BVI user testing for consuming cell outputs
  • user testing of the flexible settings configuration

automated testing

  • pytest-axe automated accessibility testing with deque axe
  • pytest-w3c automated accessibility testing with w3c nu validator
  • export rendered pdf
  • automated screen reader testing with guidepup.dev #29
  • automated screen reader and accessibility testing with robot framework
  • pytest-equal-access automated accessibility testing with IBM equal access
  • automated accessibility testing with chrome extensions (eg WAVE) in playwright.

third party testing

we need to test and track third party accessibility violations of upstream libraries. these libraries can be patched by nbconvert-a11y or track upstream changes. the efforts are a new contribution model where community members are encouraged to contribute tests verifying inaccessibility. nbconvert-a11y can provide a central authority for accessibility efforts rather than diffuse upstream efforts.

  • pygments
  • ipywidgets
  • pytest-html
  • flask dev mode
  • pandas
  • matplotlib
  • ipython

packaging

nbconvert-a11y will incubate integrations and extensions to third party software. initially, the requirements to use these tools (eg pytest extensions) are optional dependencies. eventually, they should be moved to their own smaller projects with less entropy.

  • create a standalone pytest-axe package
  • create a standalone pytest-w3c package
  • create a mkdocs extensions
  • create a sphinx extensions nbconvert-a11y is not readily compatible with sphinx.

developer experience

  • containers.dev integration for better developer experiences, collaboration, and events.
  • a community calendar to manage meetings
  • screen reader workshops to improve literacy among our developers.
  • an in person event
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant