Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation to display required minimum version of glibc and retroactively supported operating systems #5877

Merged
merged 4 commits into from
Jul 26, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/getting-started/installing-cypress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ requirements:
### Linux Prerequisites

If you're using Linux, you'll want to have the required dependencies installed
on your system. Depending on your system defaults, these dependencies may already be installed.
on your system. Cypress on Linux requires a minimum [`glibc`](https://www.gnu.org/software/libc/) version of `2.17`. Depending on your system defaults, these dependencies may already be installed.
Copy link
Contributor

@MikeMcC399 MikeMcC399 Jul 26, 2024

Choose a reason for hiding this comment

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

That does not read so well in front of the sentence "Depending on your system defaults, these dependencies may already be installed." as it implies that you can change it, whereas it is a fixed version completely tied to the version of the operating system you are using. It would be better as a separate paragraph or dropped from this section.

The follow-on paragraph also suggests that you can install a different version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How is something like 091fe97?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm fine with the replacement paragraph.

If not, run the command line for your operating system listed below.
See below under [Docker Prerequisites](#Docker-Prerequisites) for information on [Cypress Docker images](https://github.com/cypress-io/cypress-docker-images). These already include the necessary dependencies.

Expand Down