[docs-infra] Fix GitHub source link redirection #43534
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
oliviertassinari
added
bug 🐛
Netlify deploy previewhttps://deploy-preview-43534--material-ui.netlify.app/ Bundle size report |
alexfauquette
approved these changes
Aug 31, 2024
| @@ -107,14 +107,13 @@ export function ComponentLinkHeader(props: ComponentLinkHeaderProps) { | |||
| size="small" | |||
| variant="outlined" | |||
| rel="nofollow" | |||
| href={`${process.env.SOURCE_CODE_REPO}/blob/v${process.env.LIB_VERSION}/${headers.githubSource}`} | |||
| href={`${process.env.SOURCE_CODE_REPO}/tree/v${process.env.LIB_VERSION}/${headers.githubSource}`} | |||
There was a problem hiding this comment.
Suggested change
| href={`${process.env.SOURCE_CODE_REPO}/tree/v${process.env.LIB_VERSION}/${headers.githubSource}`} | |
| href={`${process.env.SOURCE_CODE_REPO}/${/\.[a-z]{2,3}$/.test(headers.githubSource) ? 'blob' : 'tree'}/v${process.env.LIB_VERSION}/${headers.githubSource}`} |
Maybe I'm overengineering But with a regexp that check if the file ends with a dot plus 2 or 3 characters, you get a fix that work for all cases.
There was a problem hiding this comment.
I would imagine that on the API page we always link files and on the demo page folders, so it might be fine?
If we start to see regressions, yeah, I would add an exception here, it must be a folder.
There was a problem hiding this comment.
This component is not on the API page. It's the header of the demo. Technically, we could put files or folders in the markdown header
This was referenced Sep 25, 2024
This was referenced Oct 3, 2024
This was referenced Oct 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a quick follow-up on #43387.
This link creates a 301, which slows the user experience by about 200ms:
I keep forgetting about tree (folder) vs. blob (file) in the URL to link in GitHub.
Also, none of the other chips have target blank, I got confused that it didn't open in the same window. I removed it for consistency of behavior. We could discuss adding to all the chips as well, but I think it's a bit beyond this scope.
Preview: https://deploy-preview-43534--material-ui.netlify.app/material-ui/react-alert/