-
Notifications
You must be signed in to change notification settings - Fork 88
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
DOC: Add link gen. screenshot, update example gif #238
DOC: Add link gen. screenshot, update example gif #238
Conversation
8f55cae
to
33d25e8
Compare
33d25e8
to
9967623
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great - two quick suggestions for extra words to clarify what's going on.
Any strong reason not to just re-use the raw.githubusercontent.com
GIFs instead of embedding them in this repository? It seems many others are doing this too.
I don't understand this question clearly @choldgraf. I have some thoughts that could be relevant to it though.
|
Co-authored-by: Chris Holdgraf <[email protected]>
I just mean link the images directly from their raw.github.com URL, rather than committing them to git history. Basically use GitHub as a CDN so that we don't grow our git repo size with images. I'm not sure whether that has implications for working on PyPI though |
Okay hmm, but they raw url refers to the github repo, but it github can indeed be used as a cdn. To not grow the github repo size, we can post the image into a github issue and then reference it, but its more complexity to maintain and understand in a way. I figure this is what i like doing for this repo and situation given that we don't change this regularly and wont grow beyond for example 10 MB anytime soon. |
Sounds good - I don't mean my comment to block this PR if others prefer to just commit things to the repository. I'll merge this in! Thanks @consideRatio for improving these docs :-) |
This is an update of the documentation example gif animation, and an extension where also a screenshot of the link generator is included.
This PR was motivated by me making a digital poster for a conference and wanted a shorter and smaller in size gif animation, that preferably also demonstrated the opening of a specified notebook, preferably in jupyterlab. Having made it, do we want to use it here?
Example use
The nbgitpuller link generator is used to create a link.
The link is clicked.