-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Convert https://docs.cypress.io/ links to local #6055
Convert https://docs.cypress.io/ links to local #6055
Conversation
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
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.
Yah I noticed some of these slipping into a recent PR. We definitely want them local so the checks run. Might be good to look for on.cypress.io links also.
It's easy to forget to strip off the domain when copying links. I was guilty of adding one of these links for Docker, which is now corrected. I did look at |
@MikeMcC399 If the result on the on.cypress.io link results in a link back to the docs itself, it should be a relative link. There may be some outside links that on.cypress.io reroutes to (like to cloud.cypress.io), those should be left. |
Understood. That is what I was assuming. |
|
Issue
Source links stored in
*.mdx
files with the published domain namehttps://docs.cypress.io/...
are not portable and may produce unexpected results when testing locally underlocalhost
.Secondly, Docusaurus does not report errors for links with external domains, meaning errors may go undetected. It only checks local links.
Missing target bookmarks
The following links resolve to a page, however the corresponding bookmark is missing from the page and so, when the link is used, the cursor is placed at the top of the page, leaving the reader to figure out what was intended:
Is-everything-captured-and-replayed-in-Test-Replay
is missing. This is logged as a separate issue Orphaned Test Replay limitations link #6054.Clicking-on-Commands
is missing.Change
Remove the external part of URLs in
*.mdx
file links containinghttps://docs.cypress.io/...
Change https://docs.cypress.io/app/core-concepts/open-mode#Clicking-on-Commands to the internal link
/app/core-concepts/open-mode#Command-Log