SPIKE: Prevent editors from saving content with links with no discernible text

kevwalsh commented 3 years ago

User Story or Problem Statement

As an editor, i want good feedback if i try to include bad links, such as

inaccessible links like <a href="/example"> </a> (or others reported by AXE checks in Nightwatch)

Acceptance Criteria

[ ] We've evaluated means of reducing accessibility issues in rich text, and ranked according to various criteria
- [ ] Impact (deliver value sooner than later, even if it's comprehensive)
- [ ] Can support a good editorial experience (which could include no known impact)
- [ ] How each solution might relate to other rich text issues (#1969) such as empty <p> tags.
[ ] Explored some existing open source tools, including https://www.drupal.org/project/ckeditor_a11ychecker https://www.drupal.org/project/ckeditor_accessibility_auditor https://www.drupal.org/project/editoria11y

Timebox at 5

Implementation steps

TBD

Previous Team Points

5

1Copenut commented 3 years ago

kevwalsh commented 3 years ago

jenkins___testing_content-build-integration-testing___content-build-integration-testing____102.png

 - sitemap 1/4 (24m 24s)

[2021-05-26T16:22:24.032Z]    Failed [fail]: (

[2021-05-26T16:22:24.032Z]              Description:  Links must have discernible text

[2021-05-26T16:22:24.032Z]              Impact:       serious

[2021-05-26T16:22:24.032Z]              Rule ID:      link-name

[2021-05-26T16:22:24.032Z]              URL:          http://content-build:3001/hudson-valley-health-care/nurse-residency-programs/

[2021-05-26T16:22:24.032Z]              DOM node:     

[2021-05-26T16:22:24.032Z]    <a href="mailto:judith.brown2@va.gov" target="_blank"> </a>

[2021-05-26T16:22:24.032Z]    a[href="mailto\:judith\.brown2\@va\.gov"][target="_blank"]:nth-child(2)

[2021-05-26T16:22:24.032Z]              More help:    https://dequeuniversity.com/rules/axe/4.1/link-name?application=axeAPI

[2021-05-26T16:22:24.032Z]            )

[2021-05-26T16:22:24.032Z]              Description:  Links must have discernible text

[2021-05-26T16:22:24.032Z]              Impact:       serious

[2021-05-26T16:22:24.032Z]              Rule ID:      link-name

[2021-05-26T16:22:24.032Z]              URL:          http://content-build:3001/hudson-valley-health-care/nurse-residency-programs/

[2021-05-26T16:22:24.032Z]              DOM node:     

[2021-05-26T16:22:24.032Z]    <a href="mailto:judith.brown2@va.gov" target="_blank"> </a>

[2021-05-26T16:22:24.032Z]    a[href="mailto\:judith\.brown2\@va\.gov"][target="_blank"]:nth-child(2)

[2021-05-26T16:22:24.032Z]              More help:    https://dequeuniversity.com/rules/axe/4.1/link-name?application=axeAPI

[2021-05-26T16:22:24.032Z]            ): Failed [fail]: (

[2021-05-26T16:22:24.032Z]              Description:  Links must have discernible text

[2021-05-26T16:22:24.032Z]              Impact:       serious

[2021-05-26T16:22:24.032Z]              Rule ID:      link-name

[2021-05-26T16:22:24.032Z]              URL:          http://content-build:3001/hudson-valley-health-care/nurse-residency-programs/

[2021-05-26T16:22:24.032Z]              DOM node:     

[2021-05-26T16:22:24.032Z]    <a href="mailto:judith.brown2@va.gov" target="_blank"> </a>

[2021-05-26T16:22:24.032Z]    a[href="mailto\:judith\.brown2\@va\.gov"][target="_blank"]:nth-child(2)

[2021-05-26T16:22:24.032Z]              More help:    https://dequeuniversity.com/rules/axe/4.1/link-name?application=axeAPI

[2021-05-26T16:22:24.032Z]            ) - Expected "undefined" but got: "undefined"

[2021-05-26T16:22:24.032Z]        at forEach (/application/content-build/src/platform/testing/e2e/nightwatch-commands/axeCheck.js:85:21)

[2021-05-26T16:22:24.032Z]        at Array.forEach (<anonymous>)

[2021-05-26T16:22:24.032Z]        at Object.<anonymous> (/application/content-build/src/platform/testing/e2e/nightwatch-commands/axeCheck.js:72:18)

swirtSJW commented 3 years ago

AS of this pr we are warning in the broken link report. It does not prevent saving, but does call it out. https://github.com/department-of-veterans-affairs/va.gov-cms/issues/5442

EWashb commented 1 year ago

Although an old ticket, I'm going to add it to the requirements definition pipeline since Laura added the appropriate accessibility label recently

srancour commented 4 days ago

@gracekretschmer-metrostar this could be a good opportunity with helping editors to make their content more accessible along with the PDF and alt-text work.

department-of-veterans-affairs / va.gov-cms