github-action icon indicating copy to clipboard operation
github-action copied to clipboard

Broken links to Cypress Troubleshooting documentation

Open MikeMcC399 opened this issue 1 month ago • 2 comments

Situation

  • This repo makes use of the http://on.cypress.io/troubleshooting and https://on.cypress.io/troubleshooting URLs with the goal of displaying the Cypress App Troubleshooting page.
  • The redirect carried out by https://on.cypress.io is wrong, and the page UI Coverage Troubleshooting is displayed instead.

Source files with broken links are:

Background

  • The controls for redirects carried out by https://on.cypress.io are sourced from a cypress.io-owned private repository. It is not possible for external contributors to view the repository or submit issues / PRs against it.
  • The issue was nevertheless raised in a Cypress public repository under https://github.com/cypress-io/cypress/issues/32393 in August 2025. Although the issue was assigned, no change was made to the redirect and so, at least to fix the problems with the issue templates in the main Cypress repo, PR https://github.com/cypress-io/cypress/pull/32991 was submitted and merged, which bypassed the redirect. This however still left the incorrect redirect unaddressed.

Assessment

  • It's unclear why the redirect of https://on.cypress.io/troubleshooting itself was not corrected in a timely manner. There was no feedback logged in the issue https://github.com/cypress-io/cypress/issues/32393
  • Fixing the redirect would still be the preferred solution

Recommendation

  • Wait for feedback from the Cypress.io team about correcting the redirect. If there are technical barriers to correcting the redirect, then re-write the affected links in this repo to bypass the redirect and hard-code the destination URL to use the Cypress documentation website https://docs.cypress.io directly:

    http://on.cypress.io/troubleshooting & https://on.cypress.io/troubleshooting => https://docs.cypress.io/app/references/troubleshooting

  • In any case, change http protocol usage to https.

MikeMcC399 avatar Nov 24 '25 08:11 MikeMcC399

@jennifer-shehane

Please fix the on.cypress.io redirect, so that

https://on.cypress.io/troubleshooting redirects to

https://docs.cypress.io/app/references/troubleshooting

or if that is not possible, please give feedback so that the broken use of https://on.cypress.io/troubleshooting can be removed from this repo.

MikeMcC399 avatar Nov 24 '25 08:11 MikeMcC399

@jennifer-shehane / @AtofStryker

This is a request to the Cypress.io team to fix the incorrect redirect https://on.cypress.io/troubleshooting redirect. Perhaps somebody could take a look at it? It's defined in a private repo, so I can't fix it myself.

Also I can no longer edit issue "Type", that I was previously able to add. Have these been disabled at the GitHub Organizational level by the cypress-io organization?

Image

MikeMcC399 avatar Dec 09 '25 10:12 MikeMcC399

@MikeMcC399 I have a feeling this link is generated by the default site map. I have a note to try and get this fixed by the end of the week by publishing the correct link. I'll post here when it's published.

As far as the issue type permissions I am not sure. @jennifer-shehane do you have any ideas around permissions changes?

AtofStryker avatar Dec 10 '25 20:12 AtofStryker

@MikeMcC399 the link should now be fixed. Can you verify?

AtofStryker avatar Dec 11 '25 20:12 AtofStryker

@AtofStryker

Thank you very much for fixing the redirect! I can confirm that accessing:

https://on.cypress.io/troubleshooting generates an HTTP 302 Found to

https://docs.cypress.io/app/references/troubleshooting

as needed.

This also means that the related issue https://github.com/cypress-io/cypress-docker-images/issues/1454 can be closed.

MikeMcC399 avatar Dec 12 '25 07:12 MikeMcC399

  • PR #1605 updated the single use of http://on.cypress.io mentioned above.

MikeMcC399 avatar Dec 12 '25 14:12 MikeMcC399