-
-
Notifications
You must be signed in to change notification settings - Fork 409
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
tutorials + gifs #419
tutorials + gifs #419
Conversation
The tutorials up to our individual layer tutorials have all been gone through and had images / gifs added. Next is to go through our individual layers, but we might want to just get this part in now and then continue work in follow-up PRs |
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.
@sofroniewn good work! I love the viewer tutorial in particular! I've made some comments but it's mostly minor stuff, typos etc.
However the big thing for me is that you're adding ~23MB of gifs to the repo in one swoop, and the prospect is only for these growing. This means that anytime someone does git clone or tries to pip install from git, they will be downloading minimum a minimum of 23MB. I don't think this is acceptable. So, my vote/suggestion/recommendation is that we publish all these materials to a new repo, napari-tutorials, for example. What do you think? Note that this is a problem we have to decide on now, not in a future PR: once the gifs are in the history, there's no removing them, short of wiping the slate clean.
For reference, we're already at 14MB and it's taking several minutes to do a bare clone from the plane. So I'm kind of inclined to do some history rewriting already! |
@jni a separate repo called |
@jni I've gone through your comments, thanks for all the feedback! I'm going to make a PR to the new https://github.com/napari/napari-tutorials repo with the revised version and change this PR to remove all the tutorials and update links in the main README.md |
This PR has been superseded by #425 and the existence of the napari-tutorials repo - https://github.com/napari/napari-tutorials/ |
Description
This PR continues our work on adding tutorials. Currently it focuses on the tutorials
README.md
, theinstallation.md
tutorial and thegetting_started.md
tutorial, including addinggifs
. There's still more work to be done on the tutorials, some of which will still happen on this PR.