suborbital / docs

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

Repair ability to run docs locally #144

Closed LauraLangdon closed 2 years ago

LauraLangdon commented 2 years ago

When trying to deploy the docs locally I've encountered some errors:

github-actions[bot] commented 2 years ago

4 total issues, 1 error, and 3 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

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

cohix commented 2 years ago

@LauraLangdon I don't think I understand what that validation error has to do with this PR? Could you help me understand?

LauraLangdon commented 2 years ago

@LauraLangdon I don't think I understand what that validation error has to do with this PR? Could you help me understand?

I've changed the PR name to reflect both problems with running the docs locally atm. I think the reason for the [ERROR] ValidationError: "algolia.appId" is required. If you haven't migrated to the new DocSearch infra, please refer to the blog post for instructions: https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration error is the same one we had previously that was resolved by adding the Algolia env vars to the cloud run deployment env (see https://discord.com/channels/808215368342044692/909816751884230656/968526616676421722). I thought the error might have recurred due to the move from Google to Vercel.

github-actions[bot] commented 2 years ago

4 total issues, 1 error, and 3 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

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

github-actions[bot] commented 2 years ago

4 total issues, 1 error, and 3 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

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

LauraLangdon commented 2 years ago

Okay, so to fix the second problem we just needed to update the Docusaurus version in package-lock.

github-actions[bot] commented 2 years ago

4 total issues, 1 error, and 3 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

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