suborbital / docs

Documentation monorepo for Suborbital projects and products
https://docs.suborbital.dev
Apache License 2.0
8 stars 5 forks source link

Create accessibility.yml #116

Closed LauraLangdon closed 2 years ago

LauraLangdon commented 2 years ago

Adding accessibility checks to docs workflow.

I'm not sure whether we can use this without getting an API key (it's listed as an optional input, so it's not clear). If we do we'd need to subscribe. No idea whether this is our best option.

flaki commented 2 years ago

I'm not sure whether we can use this without getting an API key (it's listed as an optional input, so it's not clear). If we do we'd need to subscribe. No idea whether this is our best option.

It looks like free scans show only a limited output: image

According to the pricing page, for one website one could use the free tier, but it's limited to 2 manual scans / 3 API requests a day. This would only become a problem if we started using this on every pull request (preview deploy), which would be inarguable the ideal usage (checking for a11y issues/regressions in preview before the merge).

If we end up implementing this (this can be a followup), we can use the basic plan ($120/yr), a 100 requests/day should be enough for a while.

LauraLangdon commented 2 years ago

Update: I've created an account and have an API token; just need to get a secret set up for it to add to the workflow.

j-mendez commented 2 years ago

Hi I am the creator of A11yWatch. Let me know if you need help with anything! @arbourd @LauraLangdon

github-actions[bot] commented 2 years ago

3 issues found for https://docs.suborbital.dev

Details WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour ```html / ``` Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. --- WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour ```html / ``` Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. --- WARNING WCAG2AA.Principle1.Guideline1_4.1_4_10.C32,C31,C33,C38,SCR34,G206 ```html Skip to main content ``` This element has "position: fixed". This may require scrolling in two dimensions, which is considered a failure of this Success Criterion. ---

πŸ“ docs | :octocat: repo | πŸ™‹πŸ½β€β™€οΈ issues | πŸͺ marketplace | A11yWatch

hola-soy-milk commented 2 years ago

Hi I am the creator of A11yWatch. Let me know if you need help with anything! @arbourd @LauraLangdon

Thank you so much, @j-mendez!

j-mendez commented 2 years ago

@LauraLangdon Sorry for the confusion on the words for the rates and plans. Currently the single scan or api endpoint /scan-simple is free for usage behind rate limits and is not site-wide. Prior there was not any authentication detection for the endpoint we just added this in now since we jumped the gun on setting it up on the CLI or action before the API was ready. Using the action or CLI to do site-wide scans is a work in progress and should be released soonπŸ™‚.