Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

updates GitHub action pa11y docs for jekyll and 11ty #320

Merged
merged 1 commit into from
Sep 7, 2022

Conversation

jduss4
Copy link
Contributor

@jduss4 jduss4 commented Sep 6, 2022

Several months ago while setting up GH Actions for an 11ty site, I discovered that the instructions in the handbook worked for jekyll but not for 11ty, which lacked a "detached" mode.

Using 11ty testing instructions from an example provided by @heymatthenry, I pulled out the shared configuration and then added sections with the specific instructions for jekyll and 11ty.

Here is the page preview in Federalist

If you were tagged as a reviewer, it's only because I don't really know who is in charge of reviewing / merging things in this repo!

@github-actions
Copy link

github-actions bot commented Sep 6, 2022

Pa11y testing results
> [email protected] pa11y-ci:sitemap
> pa11y-ci --sitemap https://engineering.18f.gov/sitemap.xml --sitemap-find https://engineering.18f.gov --sitemap-replace http://localhost:4000 --sitemap-exclude "/*.pdf"

Running Pa11y on 44 URLs:
 > http://localhost:4000/about/ - 0 errors
 > http://localhost:4000/architecture-reviews/ - 0 errors
 > http://localhost:4000/apis/ - 0 errors
 > http://localhost:4000/accessibility-scanning/ - 0 errors
 > http://localhost:4000/architecture-reviews/data-act-pilot/ - 0 errors
 > http://localhost:4000/architecture-reviews/micro-purchase/ - 0 errors
 > http://localhost:4000/books-we-have-read/ - 0 errors
 > http://localhost:4000/browser-testing/ - 0 errors
 > http://localhost:4000/code-review/ - 0 errors
 > http://localhost:4000/continuous-deployment/ - 0 errors
 > http://localhost:4000/datastore-selection/ - 0 errors
 > http://localhost:4000/development-environments/ - 0 errors
 > http://localhost:4000/example-workflows/ - 0 errors
 > http://localhost:4000/docker/ - 0 errors
 > http://localhost:4000/css/ - 0 errors
 > http://localhost:4000/frontend/ - 0 errors
 > http://localhost:4000/incident-reports/cloud-gov/ - 0 errors
 > http://localhost:4000/ - 0 errors
 > http://localhost:4000/incident-reports/ - 0 errors
 > http://localhost:4000/integrations/ - 0 errors
 > http://localhost:4000/language-selection/ - 0 errors
 > http://localhost:4000/javascript/ - 0 errors
 > http://localhost:4000/license/ - 0 errors
 > http://localhost:4000/laptop-setup/ - 0 errors
 > http://localhost:4000/markdown/ - 0 errors
 > http://localhost:4000/nodejs/ - 0 errors
 > http://localhost:4000/on-call/ - 2 errors
 > http://localhost:4000/people/ - 0 errors
 > http://localhost:4000/people/assessment/ - 0 errors
 > http://localhost:4000/project-setup/ - 0 errors
 > http://localhost:4000/python/ - 0 errors
 > http://localhost:4000/release-strategies/ - 0 errors
 > http://localhost:4000/resources/ - 0 errors
 > http://localhost:4000/ruby/ - 0 errors
 > http://localhost:4000/security/ - 0 errors
 > http://localhost:4000/security/cloud-services/ - 0 errors
 > http://localhost:4000/security/content-security-policy/ - 0 errors
 > http://localhost:4000/security/dependency-remediation/ - 0 errors
 > http://localhost:4000/security/output-encoding/ - 0 errors
 > http://localhost:4000/security/incident-response-drills/ - 0 errors
 > http://localhost:4000/sharepoint/ - 0 errors
 > http://localhost:4000/tests/ - 0 errors
 > http://localhost:4000/web-architecture/ - 0 errors
 > http://localhost:4000/workflow/ - 0 errors

Errors in http://localhost:4000/on-call/:

 • ARIA role must be appropriate for the element
   (https://dequeuniversity.com/rules/axe/3.5/aria-allowed-role?application=axeAPI)

   (#fnref:1)

   <sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote...</sup>

 • ARIA role must be appropriate for the element
   (https://dequeuniversity.com/rules/axe/3.5/aria-allowed-role?application=axeAPI)

   (#fnref:2)

   <sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote...</sup>

✘ 43/44 URLs passed

Copy link
Collaborator

@echappen echappen left a comment

Choose a reason for hiding this comment

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

I'm unfamiliar with 11ty configuration, but from a content perspective this lgtm.

@svenaas
Copy link

svenaas commented Sep 6, 2022

I also cannot add insight on the 11ty details but otherwise appreciate the contribution and think this looks good. I'm adding @kbighorse as reviewer and tagging @apburnes who has worked with 11ty and might have suggestions.

Copy link
Member

@heymatthenry heymatthenry left a comment

Choose a reason for hiding this comment

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

LGTM! As long as folks are ok with the dependency of start-server-and-test. I find it very helpful, so it's definitely worth adding IMO.

Copy link
Contributor

@kbighorse kbighorse left a comment

Choose a reason for hiding this comment

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

Appears much better than what we had before, thanks @jduss4!

@jduss4 jduss4 merged commit 90a11c3 into main Sep 7, 2022
@jduss4 jduss4 deleted the testing-eleventy branch September 7, 2022 17:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants