Differing Dependency lists
MikeMcC399 opened this issue · 5 comments
Subject
https://on.cypress.io/required-dependencies
Description
Issue
If Cypress is run on a Linux system where dependencies are missing, then npx cypress run throws an error and lists the documentation link https://on.cypress.io/required-dependencies.
The link https://on.cypress.io/required-dependencies redirects to
https://docs.cypress.io/guides/continuous-integration/introduction#Dependencies which contains dependency information for
The equivalent list on
https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites contains dependency information for several additional environments:
- Users directed to the short list will be missing some information
- The redirection appears to assume that missing dependencies only occur in CI environments, however that is not necessarily the case.
Suggestion
- Consolidate dependencies under one list https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites
- Remove the details on https://docs.cypress.io/guides/continuous-integration/introduction#Dependencies and refer instead to the getting-started location
- Redirect https://on.cypress.io/required-dependencies to https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites where the list is longer, more complete and does not assume that dependency issues only occur under CI.
This issue needs feedback whether it should be implemented.
- I can provide a PR for text changes
- Cypress.io would need to change the redirection. I don't have access to this setup.
These suggestions sound fine. And yah, we have to update the on link. I can open a PR for that.
The PR to update the onlink is complete - it will be live on the next Cloud release (maybe after Wednesday?)
Thanks for your approval and getting the link change into the pipeline!
I'll start working on a PR for the text changes. The link and text changes don't need to be synchronized exactly, so this isn't time-critical.
- PR #5751 is submitted with suggestions for this change.