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

fix(docs): Update broken links in docs. #8847

Merged
merged 3 commits into from
Aug 18, 2019

Conversation

jessestuart
Copy link
Contributor

Summary

Stumbled upon a broken link and figured I'd fix things up. Looks like the file was simply migrated to TypeScript from JS, but the link was never updated.

Test plan

Before: 😢
Screen Recording 2019-08-18 at 12 37 AM

After rebuilding the docs site [e.g., cd website && yarn build && cd build/jest && serve]): 👌
Screen Recording 2019-08-18 at 12 38 AM


While I was at it, I grep'd through the docs codebase to see if I could find any other stray broken links, and found a few docs pointing to a types/TestRunner.js file that no longer exists. Looks like the 404 was fixed in v24.1, but wasn't back-ported to earlier releases:

λ rg types/TestRunner.js --files-with-matches
website/versioned_docs/version-24.0/Configuration.md
website/versioned_docs/version-23.x/Configuration.md
website/versioned_docs/version-22.x/Configuration.md

I updated those references to match the upstream docs. Not sure what the policy here is on "rewriting history" when it comes to versioned documentation... but I figure a working link that points in the right direction is better than a 404, even if things have changed. Happy to revert if others disagree. ¯\_(ツ)_/¯

Signed-off-by: Jesse Stuart <hi@jessestuart.com>
Signed-off-by: Jesse Stuart <hi@jessestuart.com>
Signed-off-by: Jesse Stuart <hi@jessestuart.com>
@jessestuart jessestuart changed the title Jesse/fix broken link fix(docs): Update broken links in docs. Aug 18, 2019
@thymikee thymikee merged commit 012472b into jestjs:master Aug 18, 2019
@SimenB
Copy link
Member

SimenB commented Aug 18, 2019

As long as they point to amster it makes sense I think. I guess we could link to tagged commits matching the version of the docs you're browsing, but I don't think that's needed.

@jessestuart jessestuart deleted the jesse/fix_broken_link branch August 18, 2019 21:18
jessestuart added a commit to jessestuart/jest that referenced this pull request Aug 18, 2019
Signed-off-by: Jesse Stuart <hi@jessestuart.com>
@thymikee
Copy link
Collaborator

@SimenB I thought exactly the same :D

thymikee pushed a commit that referenced this pull request Aug 19, 2019
Signed-off-by: Jesse Stuart <hi@jessestuart.com>
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants