Skip to content

Update install page to remove direct download #6249

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

Merged
merged 10 commits into from
Aug 15, 2025

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Aug 14, 2025

@jennifer-shehane jennifer-shehane self-assigned this Aug 14, 2025

[Yarn (Modern)](https://yarnpkg.com/) configuration using [nodeLinker: "node-modules"](https://yarnpkg.com/configuration/yarnrc#nodeLinker)
is preferred. Cypress [Component Testing](/app/core-concepts/testing-types#What-is-Component-Testing) is not currently compatible with the default setting [nodeLinker: "pnp"](https://yarnpkg.com/configuration/yarnrc#nodeLinker) which uses [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp).

#### pnpm Configuration
#### pnpm users
Copy link
Contributor

Choose a reason for hiding this comment

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

Renaming this section heading according to the audience it addresses, instead of describing the contents, causes a broken anchor:

  - Broken anchor on source page path = /app/references/error-messages:
     -> linking to /app/get-started/install-cypress#pnpm-Configuration

Consider reverting to the original section heading text. If not, then the error-messages page needs changing.

Copy link
Member Author

Choose a reason for hiding this comment

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

Resolved here: 857f14e

Copy link
Contributor

@MikeMcC399 MikeMcC399 left a comment

Choose a reason for hiding this comment

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

Fails to build

  Exhaustive list of all broken anchors found:
  - Broken anchor on source page path = /app/get-started/install-cypress:
     -> linking to #Install (resolved as: /app/get-started/install-cypress#Install)
  - Broken anchor on source page path = /app/references/error-messages:
     -> linking to /app/get-started/install-cypress#pnpm-Configuration

Copy link
Contributor

@MikeMcC399 MikeMcC399 left a comment

Choose a reason for hiding this comment

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

Instead of using "+" notation, for instance "macOS 11+" for which there is no readily available standard documentation, consider using node-semver ranges which is more flexible, is unambiguous and has documented meaning. The supported range of macOS operating systems would then be written as "macOS >=11". It also allows defining a range "macOS >=11 <=15", for instance if there were to be a need to rule out macOS 26 Tahoe, without changing the notation scheme.

In the Linux Prerequisites section, there is a need for a update (see #6246), although I can write "Ubuntu 24.04+" and hope that it will be correctly understood, where I need to write "Ubuntu below 24.04", then "Ubuntu 24.04-" doesn't do it because it's not clear whether it is "<" or "<=". In fact I need "Ubuntu <24.04" and that meaning is clear.

@jennifer-shehane
Copy link
Member Author

@MikeMcC399 Yah I just want some syntax that is shorter than 'and above', so that would work also.

@jennifer-shehane
Copy link
Member Author

I updated to use semver >= instead of +. This won't work for replacing 'and below' because that ends up being invalid markdown, but that's fine.

Screenshot 2025-08-15 at 10 25 34 AM

Copy link

cypress bot commented Aug 15, 2025

cypress-documentation    Run #622

Run Properties:  status check passed Passed #622  •  git commit 2dfc8150b2: lint
Project cypress-documentation
Branch Review remove-direct-dl-install
Run status status check passed Passed #622
Run duration 04m 15s
Commit git commit 2dfc8150b2: lint
Committer Jennifer Shehane
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 309
View all changes introduced in this branch ↗︎
UI Coverage  10.87%
  Untested elements 2476  
  Tested elements 3  
Accessibility  96.99%
  Failed rules  0 critical   3 serious   4 moderate   0 minor
  Failed elements 27  

@MikeMcC399
Copy link
Contributor

@jennifer-shehane

I updated to use semver >= instead of +. This won't work for replacing 'and below' because that ends up being invalid markdown, but that's fine.

Sorry, I hadn't tested that before I suggested it. It's a problem with MDX, not the base MD Markdown. Fortunately there is a workaround using backslash as an escape character:

For Ubuntu \<=22.04 and Debian:

@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Aug 15, 2025

Thanks for reverting to "pnpm Configuration"! That would otherwise have needed a redirect, because the GitHub Actions repo also links to it.

You might also want to consider reverting to "Yarn Configuration" as well, just for consistency, although I don't think there is anywhere else that links to this section.

Overall the page looks much better and clearer now!

Linting would like a couple of minor tweaks for the table and an extra blank line removed that crept into the changelog.

AtofStryker
AtofStryker previously approved these changes Aug 15, 2025
@AtofStryker AtofStryker dismissed their stale review August 15, 2025 16:45

approved by accident

@AtofStryker
Copy link
Contributor

@jennifer-shehane

I updated to use semver >= instead of +. This won't work for replacing 'and below' because that ends up being invalid markdown, but that's fine.

Sorry, I hadn't tested that before I suggested it. It's a problem with MDX, not the base MD Markdown. Fortunately there is a workaround using backslash as an escape character:

For Ubuntu \<=22.04 and Debian:

hopefully nothing weird happens when you run the linter/formatter with this. I would also think the character code would be supported

@MikeMcC399
Copy link
Contributor

@AtofStryker

hopefully nothing weird happens when you run the linter/formatter with this. I would also think the character code would be supported

Before I suggested this one, I did try it out, and it worked.

@jennifer-shehane jennifer-shehane merged commit 276f0a9 into release/15.0.0 Aug 15, 2025
11 checks passed
@jennifer-shehane jennifer-shehane deleted the remove-direct-dl-install branch August 15, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants