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

tutorials + gifs #419

Closed
wants to merge 9 commits into from
Closed

Conversation

sofroniewn
Copy link
Contributor

Description

This PR continues our work on adding tutorials. Currently it focuses on the tutorials README.md, the installation.md tutorial and the getting_started.md tutorial, including adding gifs. There's still more work to be done on the tutorials, some of which will still happen on this PR.

@sofroniewn sofroniewn added this to the 0.1.0 milestone Jul 15, 2019
@sofroniewn sofroniewn added this to In progress in Docs, Examples, Tutorials, and Install via automation Jul 15, 2019
@sofroniewn sofroniewn changed the title [WIP] tutorials + gifs tutorials + gifs Jul 16, 2019
@sofroniewn
Copy link
Contributor Author

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

@sofroniewn sofroniewn requested a review from a team July 16, 2019 15:05
Copy link
Member

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tutorials/README.md Outdated Show resolved Hide resolved
tutorials/README.md Outdated Show resolved Hide resolved
tutorials/getting_started.md Outdated Show resolved Hide resolved
tutorials/viewer.md Outdated Show resolved Hide resolved
tutorials/viewer.md Outdated Show resolved Hide resolved
tutorials/viewer.md Outdated Show resolved Hide resolved
tutorials/viewer.md Outdated Show resolved Hide resolved
tutorials/viewer.md Outdated Show resolved Hide resolved
@jni
Copy link
Member

jni commented Jul 16, 2019

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!

@sofroniewn
Copy link
Contributor Author

@jni a separate repo called napari-tutorials works for me. i'll work on the changes you requested and then create a new repo and move everything over there. as to the git rewriting - up to you, I never look at the history

@sofroniewn
Copy link
Contributor Author

@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

@sofroniewn
Copy link
Contributor Author

This PR has been superseded by #425 and the existence of the napari-tutorials repo - https://github.com/napari/napari-tutorials/

@sofroniewn sofroniewn closed this Jul 17, 2019
Docs, Examples, Tutorials, and Install automation moved this from In progress to Done Jul 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants