jupyter icon indicating copy to clipboard operation
jupyter copied to clipboard

Link to dev-install from Install section.

Open Carreau opened this issue 9 years ago • 2 comments

Jupyter install page could probably link to dev-install instructions or give some hints. Shouldn't be too hard as for most project it's

  • clone repo
  • cd into repo
  • pip install -e .
  • enjoy

Carreau avatar Feb 17 '16 21:02 Carreau

I don't think we should encourage new contributors to try to do anything beyond spelling corrections with the install docs. We know from experience with IPython how easily install docs can gradually grow into a massive, offputting dump of information. The install page is absolutely critical for new users, and we've spent some time already refining it in Jupyter.

This is a more general pet peeve of mine: trying to get newcomers to contribute by writing docs. Good docs are really hard to write, and require a thorough knowledge of the project. Newcomers may be better able to see where existing docs fall short, but in most circumstances, it needs people with considerable experience to work on them. I think it's a form of programmer laziness - we don't want to write docs ourselves, so we try to pass it off to people who're looking for a way to contribute.

takluyver avatar Feb 17 '16 21:02 takluyver

Fair enough.

Carreau avatar Feb 17 '16 22:02 Carreau