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

DOC: Add link gen. screenshot, update example gif #238

Merged
merged 4 commits into from
Dec 28, 2021

Conversation

consideRatio
Copy link
Member

@consideRatio consideRatio commented Dec 18, 2021

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

  1. The nbgitpuller link generator is used to create a link.

    nblinkpuller-link-generator

  2. The link is clicked.

    nbgitpuller-demo

@consideRatio consideRatio force-pushed the pr/docs-update-gif-anim branch 2 times, most recently from 8f55cae to 33d25e8 Compare December 18, 2021 12:58
Copy link
Member

@choldgraf choldgraf left a 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.

README.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@consideRatio
Copy link
Member Author

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.

  • I want a README.md file to render well at pypi.org as well as github.com
  • I could make the docs point to an external URL, but if the .gif is part of the repo anyhow, I figure its fine to reference it directly instead

@choldgraf
Copy link
Member

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

@consideRatio
Copy link
Member Author

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.

@choldgraf
Copy link
Member

choldgraf commented Dec 28, 2021

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 :-)

@choldgraf choldgraf changed the title docs: add link gen. screenshot, update example gif DOC: Add link gen. screenshot, update example gif Dec 28, 2021
@choldgraf choldgraf merged commit 99e53ed into jupyterhub:main Dec 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants