User Guide: Use absolute URLs for notebook images to fix GitHub rendering#164
Open
brycelelbach wants to merge 1 commit intomainfrom
Open
User Guide: Use absolute URLs for notebook images to fix GitHub rendering#164brycelelbach wants to merge 1 commit intomainfrom
brycelelbach wants to merge 1 commit intomainfrom
Conversation
Contributor
❌ Link Check FailedBroken links were detected in this PR. Please check the workflow run logs for details on which links are broken. Common fixes:
To test links locally:./brev/test-links.bash . |
Collaborator
|
@brycelelbach It looks like the Link Check failed here. We should fix that before pushing this change. |
Collaborator
Author
The link failure is in the GPU deployment guide, caused by the Brev docs changing; there was already a fix in flight, but not in this branch: #165 |
brycelelbach
force-pushed
the
fix/notebook-images-lfs
branch
from
0327a80 to
5e992ba
Compare
…ring. GitHub's notebook renderer resolves relative image paths via raw.githubusercontent.com, which serves Git LFS pointer files as text/plain instead of actual image content. Replace relative paths with absolute media.githubusercontent.com URLs that correctly serve LFS content. SVG references (not in LFS) are left as relative paths.
brycelelbach
force-pushed
the
fix/notebook-images-lfs
branch
from
5e992ba to
f8cfe06
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
raw.githubusercontent.com, which serves Git LFS pointer files astext/plaininstead of actual image content. This breaks all LFS-tracked images in the Accelerated Python User Guide notebooks when viewed on GitHub.media.githubusercontent.comURLs, which correctly serve LFS content.chapter-02//gpu-kernel-exec.png).See brycelelbach/jupyter-github-relative-image-test for a minimal reproduction of the underlying GitHub bug.