fix(docs): Update broken links in docs. #8847
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
changed the title
thymikee
approved these changes
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
added a commit
to jessestuart/jest
that referenced
this pull request
Aug 18, 2019
Signed-off-by: Jesse Stuart <hi@jessestuart.com>
|
@SimenB I thought exactly the same :D |
thymikee
pushed a commit
that referenced
this pull request
Aug 19, 2019
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: 😢
After rebuilding the docs site [e.g.,
cd website && yarn build && cd build/jest && serve]): 👌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.jsfile that no longer exists. Looks like the 404 was fixed in v24.1, but wasn't back-ported to earlier releases: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.
¯\_(ツ)_/¯