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

Fix accessibility issues by updating the govuk_tech_docs gem to 2.2.0 [before 31 March] #104

Closed
3 tasks done
36degrees opened this issue Mar 12, 2021 · 2 comments · Fixed by #107
Closed
3 tasks done
Assignees
Labels
Effort: days Used by the team when triaging

Comments

@36degrees
Copy link
Contributor

36degrees commented Mar 12, 2021

What

First, update the govuk_tech_docs gem from 2.1.0 to 2.2.0.

Change log

2.2.0

Accessibility Fixes

Docs

2.1.1

Fixes

We’ve made fixes in the following pull requests:

Ruby version bump

We've updated the Ruby version supported:

Then identify and fix any tables which require row level headers.

There is a single table in migrating from legacy products, and multiple tables in the Sass API reference docs.

Why

Version 2.2.0 of the tech docs gem is now live and incorporates fixes to a number of accessibility issues in the technical documentation template which are referenced in our accessibility statement:

  • Some tables in content do not have column row headers when needed.
  • Users cannot tab to code examples to scroll them using the keyboard.
  • The search field and the ‘Hide table of contents’ button are not placed logically in the focus order.
  • Users can focus elements that are hidden visually behind other content, for example when using the search field.
  • Images link to a new tab without telling users, and do not have link text.

Done when

  • Gem updated
  • Tables include row headers where required
  • Verified that the issues listed in the accessibility statement are fixed (see guidance)
@36degrees 36degrees changed the title Fix accessibility issues by updating the govuk_tech_docs gem to 2.2.0 Fix accessibility issues by updating the govuk_tech_docs gem to 2.2.0 [before 31 March] Mar 12, 2021
@36degrees 36degrees added the Effort: hours Used by the team when triaging label Mar 12, 2021
@EoinShaughnessy
Copy link
Contributor

Have raised PR for Gemfile update: #106

@EoinShaughnessy
Copy link
Contributor

EoinShaughnessy commented Mar 18, 2021

Have raised PR for fix to migrating-from-legacy-products table: #107

@EoinShaughnessy EoinShaughnessy added Effort: days Used by the team when triaging and removed Effort: hours Used by the team when triaging labels Mar 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: days Used by the team when triaging
Projects
Development

Successfully merging a pull request may close this issue.

3 participants