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
AtofStryker added a commit that referenced this pull request Aug 20, 2025
* chore: remove CDP deprecation notice in launching browsers related to firefox (#6116)

* chore: Node.js 18/23 removal (#6138)

* Update Node.js versions that will be supported for 15

* update lowest npm version supported

* chore: update typescript docs to tsx (#6155)

* chore: remove ts-node references and workarounds and replace them with tsx

* add empty changelog entry for 15 to allow for linked out changes to build

* chore: add beginning of migration guide for Cypress 15 (#6159)

* chore: add begining of migration guide for Cypress 15

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

---------

Co-authored-by: Mike McCready <[email protected]>

* chore: make the minimum version of angular 18+ (#6168)

* chore: add webpack 4 migration guide / workarounds (#6164)

* chore: merge dev into 15 (#6172)

* Add Windows 2025 to supported OS list (#6142)

* New user roles and permissions defined (#6143)

* chore: release 14.3.0 documentation (#6144)

* feat: documentation for the press() command (#6135)

* docs for the press() command, including a callout in the accessibility guide

* add press to TOC

* Move some content around, mention accesiibility

* remove 'focus' note

* Document Keyboard.Keys

* update reference to command

* Update example to be a little more real case

* Add another example of autocomplete with tab

* Add link to keyboard api page

* Fix version number for introduction

* Fix broken link

* alphabetize see also

* Update package.json

Co-authored-by: Mike McCready <[email protected]>

* Fix broken link

* lint

---------

Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Mike McCready <[email protected]>

* chore: add 14.3.0 changelog to documentation

* Update docs/app/guides/accessibility-testing.mdx

* Update docs/app/references/changelog.mdx

Co-authored-by: Bill Glesias <[email protected]>

---------

Co-authored-by: Cacie Prins <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Mike McCready <[email protected]>

* Correct parameter usage for click() in shadow.mdx (#6145)

* Update shadow.mdx

- Update the suggestion to pass 'top' to cy.click() using the options defined in cy.click()'s documentation

* Update shadow.mdx

Add missing quote

* Update shadow.mdx

One-line for prettier reasons

* Correct command syntax (#6148)

Adds the missing `s` to `Cypress.Command.overwrite()`

* extend pnpm config instructions (#6149)

* fix cy.origin() "yielding a value" example (#6152)

* Update results-api.mdx (#6150)

* chore: add 14.3.1 changelog (#6153)

* chore: add 14.3.1 changelog

* Update docs/app/references/changelog.mdx

Co-authored-by: Mike McCready <[email protected]>

* empty commit to rekick build

---------

Co-authored-by: Mike McCready <[email protected]>

* docs: harmonize on injectDocumentDomain removal in future version (#6154)

* Add experimentalSessionAndOrigin removed comment to origin video (#6158)

* Fix "cy.visit() succeeded, but commands are timing out" error example (#6157)

* Cross-link cy.origin and injectDocumentDomain (#6156)

* chore: add cypress 14.3.2 changelog (#6160)

* Change 'add on' to 'premium solution' for UI Cov & a11y products (#6162)

* UI Coverage and Branch Review updates (#6167)

* add AQ links and button space

* use onlinks for demo vids

* update Cypress

* content updates

* content tweaks

* add last images

* lint-fix

* simplify

* add detail view docs and clean up

* lint fix

* Update docs/cloud/get-started/introduction.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/ui-coverage/core-concepts/compare-reports.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/ui-coverage/core-concepts/compare-reports.mdx

Co-authored-by: Mike McCready <[email protected]>

* revert cypress version bump

* restore package-lock

* remove yarn lockfile

* Update docs/app/get-started/why-cypress.mdx

Co-authored-by: Tyler Biethman <[email protected]>

* Update docs/cloud/features/branch-review.mdx

Co-authored-by: Tyler Biethman <[email protected]>

* Update docs/cloud/features/branch-review.mdx

Co-authored-by: Tyler Biethman <[email protected]>

---------

Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: Tyler Biethman <[email protected]>

* chore: add 14.3.3 changelog (#6171)

* chore: add 14.3.3 changelog

* Update docs/app/references/changelog.mdx

Co-authored-by: Matt Schile <[email protected]>

---------

Co-authored-by: Matt Schile <[email protected]>

* Rework instructions for missing Cypress binary in CI (#6170)

* Node.js 18 EOL (#6165)

* Add quoting advice for PowerShell CLI options (#6169)

* Add quoting advice for PowerShell CLI options

* Fix --config typo

Co-authored-by: Jennifer Shehane <[email protected]>

---------

Co-authored-by: Jennifer Shehane <[email protected]>

* Bump Cypress Docker versions in examples to Node.js 22.15.0 LTS (#6161)

---------

Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: danjohansenconsulting <[email protected]>
Co-authored-by: Cacie Prins <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Matthew Sbar <[email protected]>
Co-authored-by: Tim Rayers <[email protected]>
Co-authored-by: Emily Wisniewski (Rohrbough) <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Tyler Biethman <[email protected]>
Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>

* Revert "chore: merge dev into 15 (#6172)" (#6174)

This reverts commit 6af2913.

* chore: add migration guide for`@cypress/webpack-batteries-included-preprocessor` built-ins removal (#6192)

* chore: add migration guide if needing webpack built-ins

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Jennifer Shehane <[email protected]>

* run linter

---------

Co-authored-by: Jennifer Shehane <[email protected]>

* baseline updates for Cypress Studio updates

* Updates for renaming SelectorPlayground to ElementSelector API (#6212)

* Updates for SelectorPlayground to ElementSelector

* add migration section for SelectorPlayground renaming

* remove links to selector-playgroun-api

* lint

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Emily Wisniewski (Rohrbough) <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Emily Wisniewski (Rohrbough) <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/api/cypress-api/element-selector-api.mdx

Co-authored-by: Mike McCready <[email protected]>

* remove note about Node.js 18 being deprecated

* Update docs/app/guides/cypress-studio.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* docs: minimum linux requirements for electron 36 (#6219)

* minimum linux requirements for electron 36

* fix deb 10 ref for cy 14

* rm tables, make concise

* Update docs/app/get-started/install-cypress.mdx

* Update docs/app/references/migration-guide.mdx

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

---------

Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Mike McCready <[email protected]>

* chore: document vite 4 removal and vite 7 support for ct (#6224)

* Rewrite to make its use more understandable + remove getSelector (#6235)

* Rewrite to make its use more understandable + remove getSelector

* Add more examples + simplify

* lint

* add note about uniqueness of selector

* lint

* Remove redundant aria-label

* Add notes about the variability of the ElementSelector API and the de… (#6238)

* Add notes about the variability of the ElementSelector API and the deprecation of Selector Playground

* update info areas

* lint fix

* Add new screenshots that match Cypress 15 design (#6240)

* begin added images of newly designed app

* add more 15 images

* lint

* Add more specific content + videos for Studio (#6245)

* Add a video for editing in studio

* More updates for Studio docs

* lint fix

* add last video

* Add limitation around cypress/grep + existing issues link

* chore: update CT docs and migration guide (#6248)

* chore: update docs with supported angular versions, webpack versions, and migration guide helpers

* fix linter issues

---------

Co-authored-by: Jennifer Shehane <[email protected]>

* chore: update code to exitCode in `cy.exec()` (#6247)

* chore: update code to exitCode

* add history to exec

* Add short migration descriptions

* chore: fix linter issues

---------

Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>

* Update install page to remove direct download (#6249)

* Update install page

* lint + link fix

* typo

* typo

* Update docs/app/get-started/install-cypress.mdx

Co-authored-by: Mike McCready <[email protected]>

* updates for broken links + semver versions + ubuntu/debian updates

* lint

* lint

---------

Co-authored-by: Mike McCready <[email protected]>

* commit summary for changelog

* chore: add Release 15.0.0 changelog (#6252)

---------

Co-authored-by: Bill Glesias <[email protected]>
Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: danjohansenconsulting <[email protected]>
Co-authored-by: Cacie Prins <[email protected]>
Co-authored-by: Matthew Sbar <[email protected]>
Co-authored-by: Tim Rayers <[email protected]>
Co-authored-by: Emily Wisniewski (Rohrbough) <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Tyler Biethman <[email protected]>
Co-authored-by: Matt Schile <[email protected]>
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