From cbb246451620e94abb9f7e94b3d310b30ccb164b Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Mon, 9 Oct 2023 13:22:34 -0400 Subject: [PATCH 1/4] docs(accessibility-scorecard): Updates content as part of content audit. --- .../developer-resources/accessibility-scorecard.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md index b1fc60b66d..03ad9492e8 100644 --- a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md +++ b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md @@ -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 essential criteria to meet. You can use this scorecard as a guide to evaluate the state of accessibility for any UI built using PatternFly. + ## 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 -Slack workspace. +The following scorecard demonstrates what a completed scorecard may look like for your product. This information can help you communicate the accessibility of your product by clearly identifying how it meets important criteria. + +Note that this example scorecard assesses the documentation on PatternFly.org. + +If you're a developer looking for more guidance on conducting an accessibility audit, refer to our [accessibility testing guide](/accessibility/testing-your-accessibility). From 0662dedf8ab6667e4c97e7c402e098be9facca6c Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Wed, 18 Oct 2023 16:16:20 -0400 Subject: [PATCH 2/4] Update packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md --- .../content/developer-resources/accessibility-scorecard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md index 03ad9492e8..0efc25c2bf 100644 --- a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md +++ b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md @@ -6,7 +6,7 @@ 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 essential criteria to meet. You can use this scorecard as a guide to evaluate the state of accessibility for any UI built using PatternFly. +To support the proper assessment of accessibility measures, we've created a scorecard that outlines the ways that we recommend testing for accessibility and how well your UI meets those expectations. You can use this scorecard as a guide to evaluate the state of accessibility for any UI built using PatternFly. ## PatternFly.org accessibility scorecard From 5d184ddb807eda6acada3fee0eded9ba559d4b1e Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Mon, 23 Oct 2023 11:28:09 -0400 Subject: [PATCH 3/4] Final tweaks to ready content for review. --- .../developer-resources/accessibility-scorecard.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md index 0efc25c2bf..923b2f0de8 100644 --- a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md +++ b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md @@ -6,14 +6,12 @@ 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 for accessibility and how well your UI meets those expectations. You can use this scorecard as a guide to evaluate the state of accessibility for any UI built using PatternFly. +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. -## PatternFly.org accessibility scorecard - -The following scorecard demonstrates what a completed scorecard may look like for your product. This information can help you communicate the accessibility of your product by clearly identifying how it meets important criteria. +If you're a developer looking for more detailed guidance on conducting an accessibility audit, refer to our [accessibility testing guide](/accessibility/testing-your-accessibility). -Note that this example scorecard assesses the documentation on PatternFly.org. +## PatternFly.org accessibility scorecard -If you're a developer looking for more guidance on conducting an accessibility audit, refer to our [accessibility testing guide](/accessibility/testing-your-accessibility). +The following example demonstrates what a completed scorecard may look like by assessing the PatternFly.org website documentation. - + \ No newline at end of file From 42106e5771f71765cce186d03b08e9ce50489a37 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Tue, 31 Oct 2023 16:55:42 -0400 Subject: [PATCH 4/4] Updates content. --- .../content/developer-resources/accessibility-scorecard.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md index 923b2f0de8..986265d81c 100644 --- a/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md +++ b/packages/documentation-site/patternfly-docs/content/developer-resources/accessibility-scorecard.md @@ -8,7 +8,9 @@ import { AccessibilityScorecard } from './accessibility-scorecard.js'; 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. -If you're a developer looking for more detailed guidance on conducting an accessibility audit, refer to our [accessibility testing guide](/accessibility/testing-your-accessibility). +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