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

Brooklyne.finni/accessibility #17064

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

brooklynebkbk
Copy link
Contributor

What does this PR do?

Updates Code Tab and Code Lang Tab links and content in an effort to make tab content more accessible

  • adding aria-role and aria-label attributes to list of tabs
  • adding aria-role and aria-controls attributes to clickable list items
  • adding id value to tab content/panel - corresponding with the clickable list item's aria-controls value

Motivation

https://datadoghq.atlassian.net/browse/WEB-2432

https://docs-staging.datadoghq.com/brooklyne.finni/accessibility/

Changes to the layouts/shortcodes/tab.html, layouts/shortcodes/tabs.html, assets/scripts/components/codetabs.js files can be observed on any pages that use the tabs shortcode
ex: https://docs-staging.datadoghq.com/brooklyne.finni/accessibility/account_management/authn_mapping/?tab=example

and changes to the layouts/shortcodes/programming-lang.html and layouts/partials/code-lang-tabs.html can be observed on api pages with tabbed content
ex: https://docs-staging.datadoghq.com/brooklyne.finni/accessibility/api/latest/

Additional Notes

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls


Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Feb 23, 2023
Copy link
Collaborator

@bgdeutsch bgdeutsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

confirming there are 0 a11y errors on the authn_mapping page now. tab functionality still looks good as well. 👍

@brooklynebkbk brooklynebkbk marked this pull request as ready for review March 13, 2023 18:42
@brooklynebkbk brooklynebkbk requested review from a team as code owners March 13, 2023 18:42
@drichards-87
Copy link
Contributor

Created DOCS-5057 for the Docs team review.

@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label Mar 13, 2023
@drichards-87
Copy link
Contributor

@brooklynebkbk Quick question. Is there anything in this PR that you'd like the Docs team to test?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants