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

docs(812): add accessibility statement to docs site #879

Merged
merged 7 commits into from
May 10, 2023

Conversation

JohnTParsons
Copy link
Collaborator

closes #812

What

  1. Background - accessibility awareness
  2. What did you do - added statement
  3. What does the reviewers should expect - new footer link and page

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

@github-actions github-actions bot added the docs Improvements or additions to documentation label May 5, 2023
@pp-serviceaccount
Copy link
Collaborator

@JohnTParsons JohnTParsons added ready for review Please assist in getting this reviewed and removed Requires design review labels May 5, 2023
@JohnTParsons JohnTParsons marked this pull request as ready for review May 9, 2023 08:00
describe('Desktop view', () => {
it('pages should have footer links', () => {
cy.mockConsentAndVisit('/');
cy.contains('a', 'Careers').should('exist');
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a good e2e test? I'm not so sure, I agree that these won't change that frequently and it's possibly not much of an issue but what feels off to me is that it's very tightly coupled to the content, conceptually to me, this is very close to a snapshot test 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Change pushed to remove footer-navigation.cy.js

Copy link
Contributor

Choose a reason for hiding this comment

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

IMO the only useful test in the header navigation is should contain burger menu when on mobile. the rest are kind of dom checkings that can and should be in jest

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@mutebg As requested, new header cypress tests removed as well

@JohnTParsons JohnTParsons force-pushed the docs/812-a11y-statement branch from f799112 to 86d2b5a Compare May 9, 2023 12:30
LukeFinch
LukeFinch previously approved these changes May 9, 2023
Vanals
Vanals previously approved these changes May 9, 2023
@JohnTParsons JohnTParsons dismissed stale reviews from Vanals and LukeFinch via 71f1936 May 10, 2023 08:25
@JohnTParsons JohnTParsons merged commit 0dcfd33 into main May 10, 2023
@JohnTParsons JohnTParsons deleted the docs/812-a11y-statement branch May 10, 2023 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation ready for review Please assist in getting this reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Accessibility Statement to NewsKit docs site
6 participants