-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Conversation
|
||
[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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Resolved here: 857f14e
There was a problem hiding this 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
There was a problem hiding this 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.
Co-authored-by: Mike McCready <[email protected]>
@MikeMcC399 Yah I just want some syntax that is shorter than 'and above', so that would work also. |
cypress-documentation
|
Project |
cypress-documentation
|
Branch Review |
remove-direct-dl-install
|
Run status |
|
Run duration | 04m 15s |
Commit |
|
Committer | Jennifer Shehane |
View all properties for this run ↗︎ |
Test results | |
---|---|
|
0
|
|
0
|
|
0
|
|
0
|
|
309
|
View all changes introduced in this branch ↗︎ |
UI Coverage
10.87%
|
|
---|---|
|
2476
|
|
3
|
Accessibility
96.99%
|
|
---|---|
|
0 critical
3 serious
4 moderate
0 minor
|
|
27
|
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:
|
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. |
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. |
Also some simplification of the install page.