18F / development-guide

A set of guidelines and best practices for an awesome software engineering team
https://engineering.18f.gov
Other
1.25k stars 122 forks source link

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

Closed jduss4 closed 2 years ago

jduss4 commented 2 years ago

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[bot] commented 2 years ago
Pa11y testing results ``` > development-guide@1.0.0 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)
svenaas commented 2 years ago

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.