CivicActions / accessibility

CivicActions Accessibility Site: A collection of resources about digital accessibility and how it aligns with open source, CivicTech and Digital Transformation.
https://accessibility.civicactions.com
Other
27 stars 11 forks source link

Replacing link text URLs with text #648

Closed dmundra closed 2 years ago

dmundra commented 2 years ago

Resolves #647 (albeit not permanently).

dmundra commented 2 years ago

@mgifford a more permanent fix would be to consider either JS or CSS from articles:

I think for now, fixing the post is good enough. What do you think?

github-actions[bot] commented 2 years ago
Pa11y testing results ``` > pa11y-ci:sitemap > pa11y-ci --sitemap http://127.0.0.1:4000/sitemap.xml --sitemap-find https://accessibility.civicactions.com --sitemap-replace http://127.0.0.1:4000 --sitemap-exclude "/*.pdf" Running Pa11y on 110 URLs: > http://localhost:4000/guide/champions-program - 0 errors > http://localhost:4000/guide/design - 0 errors > http://localhost:4000/guide/documents - 0 errors > http://localhost:4000/guide/events - 0 errors > http://localhost:4000/guide/glossary - 0 errors > http://localhost:4000/guide/history - 0 errors > http://localhost:4000/guide/identity-language - 0 errors > http://localhost:4000/guide/introduction - 0 errors > http://localhost:4000/guide/onboarding-staff - 0 errors > http://localhost:4000/guide/organizations - 0 errors > http://localhost:4000/guide/plain-language - 0 errors > http://localhost:4000/guide/resources - 0 errors > http://localhost:4000/guide/semantic-html - 0 errors > http://localhost:4000/guide/social-media - 0 errors > http://localhost:4000/guide/tools - 0 errors > http://localhost:4000/guide/training - 0 errors > http://localhost:4000/about/people/daniel-mundra - 0 errors > http://localhost:4000/about/people/jack-haas - 0 errors > http://localhost:4000/about/people/jennifer-aube - 0 errors > http://localhost:4000/about/people/jonathan-bourland - 0 errors > http://localhost:4000/about/people/luke-fretwell - 0 errors > http://localhost:4000/about/people/michelle-kang - 0 errors > http://localhost:4000/about/people/mike-gifford - 0 errors > http://localhost:4000/about/people/nira-datta - 0 errors > http://localhost:4000/about/people/vanessa-luxen - 0 errors > http://localhost:4000/personas/accessibility-avery - 0 errors > http://localhost:4000/personas/designer-darcy - 0 errors > http://localhost:4000/personas/engineer-emery - 0 errors > http://localhost:4000/personas/procurement-parker - 0 errors > http://localhost:4000/personas/qa-quincy - 0 errors > http://localhost:4000/personas/remote-raz - 0 errors > http://localhost:4000/playbook/AT - 0 errors > http://localhost:4000/playbook/ai-and-ia - 0 errors > http://localhost:4000/playbook/authoring - 0 errors > http://localhost:4000/playbook/automated-testing - 0 errors > http://localhost:4000/playbook/checklists - 0 errors > http://localhost:4000/playbook/community - 0 errors > http://localhost:4000/playbook/distributed-teams - 0 errors > http://localhost:4000/playbook/documents - 0 errors > http://localhost:4000/playbook/follow-global-initiatives - 0 errors > http://localhost:4000/playbook/manual-testing - 0 errors > http://localhost:4000/playbook/personalization - 0 errors > http://localhost:4000/playbook/practice - 0 errors > http://localhost:4000/playbook/pwd - 0 errors > http://localhost:4000/playbook/roles - 0 errors > http://localhost:4000/playbook/statements - 0 errors > http://localhost:4000/playbook/training - 0 errors > http://localhost:4000/posts/hello-world - 0 errors > http://localhost:4000/posts/gcn-accessibility-compliance-as-code - 0 errors > http://localhost:4000/posts/improve-government-accessibility-through-open-source - 0 errors > http://localhost:4000/posts/govtech-how-will-biden-transform-government-website-accessibility - 0 errors > http://localhost:4000/posts/automated-accessibility-testing-leveraging-github-actions-and-pa11y-ci-with-axe - 0 errors > http://localhost:4000/posts/at-banter-podcast - 0 errors > http://localhost:4000/posts/mvp-playbook - 0 errors > http://localhost:4000/posts/mvp-guide - 0 errors > http://localhost:4000/posts/smashingmag-baking-in-accessibility-testing - 0 errors > http://localhost:4000/posts/pre-GAAD-Authoring-Tools-Built-in-Accessibility - 0 errors > http://localhost:4000/posts/website-analytics - 0 errors > http://localhost:4000/posts/how-we-scale-inclusive-website-content-with-automated-testing-and-open-source-tools - 0 errors > http://localhost:4000/posts/social-media-accessibility-guide - 0 errors > http://localhost:4000/posts/plain-language-accessibility-guide - 0 errors > http://localhost:4000/posts/heart-accessibility - 0 errors > http://localhost:4000/posts/scanning-over-two-million-gov-pages - 0 errors > http://localhost:4000/posts/gsa-machine-readable-acr - 0 errors > http://localhost:4000/posts/CivicActions-Creates-Open-Product-Accessibility-Template - 0 errors > http://localhost:4000/posts/CivicActions-Accessibility-Pledge - 0 errors > http://localhost:4000/posts/Talking-Drupal-Podcast - 0 errors > http://localhost:4000/projects/drupal - 0 errors > http://localhost:4000/projects/uswds-color - 0 errors > http://localhost:4000/projects/uswds - 0 errors > http://localhost:4000/roles/content-designer - 0 errors > http://localhost:4000/roles/developer - 0 errors > http://localhost:4000/roles/executive - 0 errors > http://localhost:4000/roles/operations - 0 errors > http://localhost:4000/roles/procurement - 0 errors > http://localhost:4000/roles/product-manager - 0 errors > http://localhost:4000/roles/project-manager - 0 errors > http://localhost:4000/roles/ux-designer - 0 errors > http://localhost:4000/topics/design - 0 errors > http://localhost:4000/topics/disability-type - 0 errors > http://localhost:4000/topics/process-policies - 0 errors > http://localhost:4000/topics/roles - 0 errors > http://localhost:4000/topics/testing - 0 errors > http://localhost:4000/topics/tools - 0 errors > http://localhost:4000/about/ - 0 errors > http://localhost:4000/accessibility - 0 errors > http://localhost:4000/agile - 0 errors > http://localhost:4000/analytics - 0 errors > http://localhost:4000/calendar - 0 errors > http://localhost:4000/colophon - 0 errors > http://localhost:4000/conduct - 0 errors > http://localhost:4000/about/contact - 0 errors > http://localhost:4000/guide/ - 0 errors > http://localhost:4000/heart - 0 errors > http://localhost:4000/help - 0 errors > http://localhost:4000/ - 0 errors > http://localhost:4000/news/ - 0 errors > http://localhost:4000/about/join - 0 errors > http://localhost:4000/license - 0 errors > http://localhost:4000/okrs - 0 errors > http://localhost:4000/open - 0 errors > http://localhost:4000/about/people/ - 0 errors > http://localhost:4000/personas/ - 0 errors > http://localhost:4000/playbook/ - 0 errors > http://localhost:4000/projects/ - 0 errors > http://localhost:4000/roles/ - 0 errors > http://localhost:4000/search - 0 errors > http://localhost:4000/services - 0 errors > http://localhost:4000/topics/ - 0 errors > http://localhost:4000/VPAT/Drupal9AccessibilityConformanceReport-December2020.html - 0 errors ✔ 110/110 URLs passed ```
github-actions[bot] commented 2 years ago

Cypress Test Results

6 tests   6 :heavy_check_mark:  20s :stopwatch: 8 suites  0 :zzz: 4 files    0 :x:

Results for commit b4abb4cb.

:recycle: This comment has been updated with latest results.

mgifford commented 2 years ago

For accessibility it is better not to have the URL, but to write descriptive text. So we can probably avoid that JS or CSS hack. But I do wonder if we should look for long URLs that we link to as part of our ci/cd process. We obviously don't want to eliminate all links, because sometimes we do want to talk about say CivicActions.ca specifically. However, we can look for long links like these.

github-actions[bot] commented 2 years ago
Pa11y testing results ``` > pa11y-ci:sitemap > pa11y-ci --sitemap http://127.0.0.1:4000/sitemap.xml --sitemap-find https://accessibility.civicactions.com --sitemap-replace http://127.0.0.1:4000 --sitemap-exclude "/*.pdf" Running Pa11y on 110 URLs: > http://localhost:4000/guide/champions-program - 0 errors > http://localhost:4000/guide/design - 0 errors > http://localhost:4000/guide/documents - 0 errors > http://localhost:4000/guide/events - 0 errors > http://localhost:4000/guide/glossary - 0 errors > http://localhost:4000/guide/history - 0 errors > http://localhost:4000/guide/identity-language - 0 errors > http://localhost:4000/guide/introduction - 0 errors > http://localhost:4000/guide/onboarding-staff - 0 errors > http://localhost:4000/guide/organizations - 0 errors > http://localhost:4000/guide/plain-language - 0 errors > http://localhost:4000/guide/resources - 0 errors > http://localhost:4000/guide/semantic-html - 0 errors > http://localhost:4000/guide/social-media - 0 errors > http://localhost:4000/guide/tools - 0 errors > http://localhost:4000/guide/training - 0 errors > http://localhost:4000/about/people/daniel-mundra - 0 errors > http://localhost:4000/about/people/jack-haas - 0 errors > http://localhost:4000/about/people/jennifer-aube - 0 errors > http://localhost:4000/about/people/jonathan-bourland - 0 errors > http://localhost:4000/about/people/luke-fretwell - 0 errors > http://localhost:4000/about/people/michelle-kang - 0 errors > http://localhost:4000/about/people/mike-gifford - 0 errors > http://localhost:4000/about/people/nira-datta - 0 errors > http://localhost:4000/about/people/vanessa-luxen - 0 errors > http://localhost:4000/personas/accessibility-avery - 0 errors > http://localhost:4000/personas/designer-darcy - 0 errors > http://localhost:4000/personas/engineer-emery - 0 errors > http://localhost:4000/personas/procurement-parker - 0 errors > http://localhost:4000/personas/qa-quincy - 0 errors > http://localhost:4000/personas/remote-raz - 0 errors > http://localhost:4000/playbook/AT - 0 errors > http://localhost:4000/playbook/ai-and-ia - 0 errors > http://localhost:4000/playbook/authoring - 0 errors > http://localhost:4000/playbook/automated-testing - 0 errors > http://localhost:4000/playbook/checklists - 0 errors > http://localhost:4000/playbook/community - 0 errors > http://localhost:4000/playbook/distributed-teams - 0 errors > http://localhost:4000/playbook/documents - 0 errors > http://localhost:4000/playbook/follow-global-initiatives - 0 errors > http://localhost:4000/playbook/manual-testing - 0 errors > http://localhost:4000/playbook/personalization - 0 errors > http://localhost:4000/playbook/practice - 0 errors > http://localhost:4000/playbook/pwd - 0 errors > http://localhost:4000/playbook/roles - 0 errors > http://localhost:4000/playbook/statements - 0 errors > http://localhost:4000/playbook/training - 0 errors > http://localhost:4000/posts/hello-world - 0 errors > http://localhost:4000/posts/gcn-accessibility-compliance-as-code - 0 errors > http://localhost:4000/posts/improve-government-accessibility-through-open-source - 0 errors > http://localhost:4000/posts/govtech-how-will-biden-transform-government-website-accessibility - 0 errors > http://localhost:4000/posts/automated-accessibility-testing-leveraging-github-actions-and-pa11y-ci-with-axe - 0 errors > http://localhost:4000/posts/at-banter-podcast - 0 errors > http://localhost:4000/posts/mvp-playbook - 0 errors > http://localhost:4000/posts/mvp-guide - 0 errors > http://localhost:4000/posts/smashingmag-baking-in-accessibility-testing - 0 errors > http://localhost:4000/posts/pre-GAAD-Authoring-Tools-Built-in-Accessibility - 0 errors > http://localhost:4000/posts/website-analytics - 0 errors > http://localhost:4000/posts/how-we-scale-inclusive-website-content-with-automated-testing-and-open-source-tools - 0 errors > http://localhost:4000/posts/social-media-accessibility-guide - 0 errors > http://localhost:4000/posts/plain-language-accessibility-guide - 0 errors > http://localhost:4000/posts/heart-accessibility - 0 errors > http://localhost:4000/posts/scanning-over-two-million-gov-pages - 0 errors > http://localhost:4000/posts/gsa-machine-readable-acr - 0 errors > http://localhost:4000/posts/CivicActions-Creates-Open-Product-Accessibility-Template - 0 errors > http://localhost:4000/posts/CivicActions-Accessibility-Pledge - 0 errors > http://localhost:4000/posts/Talking-Drupal-Podcast - 0 errors > http://localhost:4000/projects/drupal - 0 errors > http://localhost:4000/projects/uswds-color - 0 errors > http://localhost:4000/projects/uswds - 0 errors > http://localhost:4000/roles/content-designer - 0 errors > http://localhost:4000/roles/developer - 0 errors > http://localhost:4000/roles/executive - 0 errors > http://localhost:4000/roles/operations - 0 errors > http://localhost:4000/roles/procurement - 0 errors > http://localhost:4000/roles/product-manager - 0 errors > http://localhost:4000/roles/project-manager - 0 errors > http://localhost:4000/roles/ux-designer - 0 errors > http://localhost:4000/topics/design - 0 errors > http://localhost:4000/topics/disability-type - 0 errors > http://localhost:4000/topics/process-policies - 0 errors > http://localhost:4000/topics/roles - 0 errors > http://localhost:4000/topics/testing - 0 errors > http://localhost:4000/topics/tools - 0 errors > http://localhost:4000/about/ - 0 errors > http://localhost:4000/accessibility - 0 errors > http://localhost:4000/agile - 0 errors > http://localhost:4000/analytics - 0 errors > http://localhost:4000/calendar - 0 errors > http://localhost:4000/colophon - 0 errors > http://localhost:4000/conduct - 0 errors > http://localhost:4000/about/contact - 0 errors > http://localhost:4000/guide/ - 0 errors > http://localhost:4000/heart - 0 errors > http://localhost:4000/help - 0 errors > http://localhost:4000/ - 0 errors > http://localhost:4000/news/ - 0 errors > http://localhost:4000/about/join - 0 errors > http://localhost:4000/license - 0 errors > http://localhost:4000/okrs - 0 errors > http://localhost:4000/open - 0 errors > http://localhost:4000/about/people/ - 0 errors > http://localhost:4000/personas/ - 0 errors > http://localhost:4000/playbook/ - 0 errors > http://localhost:4000/projects/ - 0 errors > http://localhost:4000/roles/ - 0 errors > http://localhost:4000/search - 0 errors > http://localhost:4000/services - 0 errors > http://localhost:4000/topics/ - 0 errors > http://localhost:4000/VPAT/Drupal9AccessibilityConformanceReport-December2020.html - 0 errors ✔ 110/110 URLs passed ```
dmundra commented 2 years ago

For accessibility it is better not to have the URL, but to write descriptive text. So we can probably avoid that JS or CSS hack. But I do wonder if we should look for long URLs that we link to as part of our ci/cd process. We obviously don't want to eliminate all links, because sometimes we do want to talk about say CivicActions.ca specifically. However, we can look for long links like these.

Long term if it is a problem we should consider either checking for this or just letting the user know to adjust the link text.