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

chore(a11y): updated a11y scorecard #3980

Merged
merged 3 commits into from
May 2, 2024

Conversation

evwilkin
Copy link
Member

Closes #3744

This PR updates the a11y scorecard with a new report link from 4/23/24 and links to a new epic (#3979) with 24 new bugs.

@patternfly-build
Copy link
Contributor

patternfly-build commented Apr 23, 2024

Comment on lines 12 to 15
<a href="https://pf-a11y_5-16-22.surge.sh/">
Initial report (May 16th, 2022)
</a>
<p>1066 violations found</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Wondering if this should be the information for the day this new report was ran for April 23 instead. I feel like the context for each new report becomes any a11y issues found as part of that report, rather than the very first report we ever ran.

So the baseline becomes the 24 violations found in this new report, and the Critical and major accessibility violations identified in item #3 resolved (%). criteria item basically becomes "N/A" until we go through to resolve issues.

Mainly wondering because as time goes on, the initial 1066 violations become less pertinent to newer reports. Curious what @jessiehuff @nicolethoen think, though.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I agree with @thatblindgeye. I think the report's terminology might be confusing by calling it "Preliminary accessibility report", but I would think that each scorecard would represent a single point in time.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, that "initial" data isn't too relevant anymore. What about simply "prior" report? I think either we:

  • List the last report that was done (in this case, our live website shows Nov 21, 2022)
  • Or we wait to update the scorecard until after work has been done on what we find. Ex: I just found 24 violations, how many have we fixed yet?
    • In this case, either it would always show "N/A" as Eric mentioned until we address & merge PRs to make the fixes (and put up another new scorecard changing from N/A to 0), or we'd wait to publish the new scorecard at all until the work is done - when do we call it done, do we have to get to 0 issues before publishing a new scorecard?

Copy link
Contributor

@thatblindgeye thatblindgeye Apr 29, 2024

Choose a reason for hiding this comment

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

That is also a good point. Maybe we update the "violations resolved" field whenever a new report is ran, rather than when we get to X issues remaining? If we plan to run and update this report more regularly that might be easier, say something like:

  1. Q1: run initial report. "Violations resolved" is N/A
  2. Q2: run a new report, and update the "Violations resolved" for the Q1 report
  3. Q3: run a new report, and update the "Violations resolved" for the Q2 report
  4. ...etc

That would paint the picture of how many a11y issues we're introducing/resolving between reports, but also keep us a bit accountable since we'd have a schedule of when we need to update that "violations resolved" field. Though that would mean altering that "Violations resolved" field since currently it's expecting to be filled out based on the current report.

Otherwise like you said we'd probably have to do something like run the report Q1 start, but wait to actually upload it until Q1 end with whatever number of violations that have been resolved.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the feedback! I've updated the wording based on this conversation to remove "preliminary" from "preliminary accessibility report", and replace "initial report" with "Q2 2024" which can be updated with each new report.

Copy link
Contributor

@jessiehuff jessiehuff left a comment

Choose a reason for hiding this comment

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

I think this looks good with the changes!

@jessiehuff jessiehuff merged commit 0154d07 into patternfly:main May 2, 2024
4 checks passed
nicolethoen pushed a commit to nicolethoen/patternfly-org that referenced this pull request May 31, 2024
* chore(a11y): updated a11y scorecard

* PR feedback - adjusted 'initial report' section with current data
nicolethoen added a commit that referenced this pull request Jun 3, 2024
* fix: bump to latest release candidates ahead of 5.2 release (#3862)

* fix: bump to latest release candidates ahead of 5.2 release

* bump to latest component groups prerelease

* bump react to pull in bug fix

* feat: release 5.3 (#3878)

* feat: 5.3 release

* update release highlights

* fix: Bump topology to 5.2.1 (#3881)

* fix: toplogy to 5.2.1

* add yarn.lock

* update release highlights

* Update broken link on develop.md

* chore(release): Updated component groups to 5.1.0 release (#3917)

* chore(release): releasing packages [ci skip]

 - @patternfly/ast-helpers@1.4.3
 - @patternfly/documentation-framework@5.4.3

chore(component-groups): Updated component groups to 5.1.0 release

chore(component-groups): Updated component groups to 5.1.0 release

* Updated version.json

* feat(Templates): add to org site (#3947)

* feat(Templates): add to org site

* update versions, fix Th

* hide prev version, update screenshots

* fix(docs): proper commit (#3968)

* feat(docs): update screenshots (#3969)

* Update link for deprecated alert (#3956)

* feat(docs): fix for missing props tables (#3981)

* chore(a11y): updated a11y scorecard (#3980)

* chore(a11y): updated a11y scorecard

* PR feedback - adjusted 'initial report' section with current data

* fix(misc): fix broken about links (#3987)

* add comparison table to table guidelines (#4006)

* add comparison table to table guidelines

* Update table.md

* Update table.md

* docs(tooltips): Creates separate tooltips writing guide. (#3999)

* docs(tooltips): Creates separate tooltips writing guide.

* Edits content.

* Removes unused image.

* Content edits to prep for reviews.

* Adds some aria attributes.

* Cross link from icons guide.

* fix: Incorrectly formatted link (#4024)

There was a link that was incorrectly formatted and let to a 404 page

* docs: Updates PatternFly mailing list link. (#4030)

* fix: update to official alpha omegas

* bump docs-framework version

---------

Co-authored-by: Donald Labaj <dlabaj@redhat.com>
Co-authored-by: kmcfaul <45077788+kmcfaul@users.noreply.github.com>
Co-authored-by: Jessie <jhuff@redhat.com>
Co-authored-by: Evan <evan.wilkinson@redhat.com>
Co-authored-by: Margot <51165119+mmenestr@users.noreply.github.com>
Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
Co-authored-by: Freya Gustavsson <freya@venefilyn.se>
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

Successfully merging this pull request may close these issues.

Run a11y report for new Org site & publish results
4 participants