Repository navigation
Make installation instructions a little less daunting #1807
Description
Per my comment here: #1806 (comment)
The installation instructions, in particular the section on installing with pip, is laden with numerous warnings and caveats. Although I believe they are all necessary I wonder if this couldn't be simplified and made a little less daunting.
I don't have an exact answer yet but I'm thinking that a pre-install checklist might be a nice way to go. Maybe also a little choose your own adventure to lead users on different platforms through the correct steps.
Activity
astrofrog commentedon Nov 19, 2013
I keep brining this up and I've met resistance in the past, but I think the installation instructions should include prominent links to 'easy' installation methods, such as anaconda, enthought, package managers, and so on.
embray commentedon Nov 19, 2013
I don't know if I've resisted that at all or not--but if so, I guess the number of caveats in the current instructions just needed to reach a critical point before I tipped.
eteq commentedon Nov 19, 2013
We are close to rolling out a new web site that should have much easier install instructions. In that case, my thought would be to leave the "daunting" install instructions in the documentation, but direct people to the web site for the "easy" version.
Or, I would also be fine with re-organizing it with a simple section at the top, and a section below called "caveats" or "common problems" or something like that.
embray commentedon Nov 20, 2013
I would like a combination of detailed instructions for the few people who might bother to read them (sysadmins, developers, etc.) and a choose your own adventure-like set of instructions (first) for users trying to just figure out quickly what the best course of action is for them.
bsipocz commentedon Jun 30, 2017
Closing this in favour of #6154. While the latter is the real duplication, I leave that open as this on is sadly somewhere at the bottom of the issue list by now.