Skip to content
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

Merged

Conversation

MikeMcC399
Copy link
Contributor

Issue

Source links stored in *.mdx files with the published domain name https://docs.cypress.io/... are not portable and may produce unexpected results when testing locally under localhost.

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:

Change

Copy link

netlify bot commented Dec 20, 2024

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 649ffdf

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399 MikeMcC399 marked this pull request as ready for review December 20, 2024 13:24
Copy link
Member

@jennifer-shehane jennifer-shehane left a 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.

@jennifer-shehane jennifer-shehane merged commit afe2767 into cypress-io:main Dec 20, 2024
7 checks passed
@MikeMcC399
Copy link
Contributor Author

@jennifer-shehane

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 on.cypress.io and there is a lot of use of this, so it looked to me like it was strategy and not a mistake. I can take a look at converting these links in the new year, if that is what you would like to have done.

@MikeMcC399 MikeMcC399 deleted the links-external-to-local branch December 20, 2024 16:20
@jennifer-shehane
Copy link
Member

@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.

@MikeMcC399
Copy link
Contributor Author

@jennifer-shehane

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.

@MikeMcC399
Copy link
Contributor Author

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