Skip to content

docs(accessibility-scorecard): Updates content as part of content audit. #3774

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.

Sign up for GitHub

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

Merged
nicolethoen merged 5 commits into from
Dec 13, 2023
Merged

docs(accessibility-scorecard): Updates content as part of content audit. #3774

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cbb2464
docs(accessibility-scorecard): Updates content as part of content audit.
edonehoo Oct 9, 2023
0662ded
Update packages/documentation-site/patternfly-docs/content/developer-…
edonehoo Oct 18, 2023
5d184dd
Final tweaks to ready content for review.
edonehoo Oct 23, 2023
42106e5
Updates content.
edonehoo Oct 31, 2023
10adf28
Merge branch 'main' into iss3773
edonehoo Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions ...ion-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ section: accessibility
---
import { AccessibilityScorecard } from './accessibility-scorecard.js';

## Scoring your accessibility

To support the proper assessment of accessibility measures, we've created a scorecard that outlines the ways that we recommend testing your UI and assessing how well it meets accessibility expectations. A completed scorecard can help you communicate the accessibility of your UI to stakeholders by clearly identifying how it meets important criteria.

Scoring your accessibility shouldn't be a one-time thing. It's something that you should do routinely to assess your product as it evolves.

An accessibility scorecard offers a higher-level overview of the current state of your product's accessibility, but it is **not intended to replace a full accessibility audit**, as described by our [accessibility testing guide](/accessibility.testing-your-accessibility). An accessibility audit is a vital part of creating your accessibility scorecard.

## PatternFly.org accessibility scorecard

The PatternFly team has created the accessibility scorecard to evaluate the state of accessibility for any UI built
using PatternFly. The scorecard represents the state of accessibility for a UI at the date of evaluation. The
PatternFly team has used this scorecard to evaluate the PatternFly documentation on PatternFly.org. A UI which desires
an accessibility evaluation and scorecard can reach out via the PatternFly
<a href="https://join.slack.com/t/patternfly/shared_invite/zt-1npmqswgk-bF2R1E2rglV8jz5DNTezMQ" target="_blank" rel="noopener noreferrer">Slack</a> workspace.
The following example demonstrates what a completed scorecard may look like by assessing the PatternFly.org website documentation.

<AccessibilityScorecard />
<AccessibilityScorecard />