spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment
https://docs.spyder-ide.org
MIT License
33 stars 283 forks source link

Installing/updating instructions need some fixes (maybe) #237

Closed thistlillo closed 3 years ago

thistlillo commented 3 years ago

I think this page needs some fixes:

https://docs.spyder-ide.org/current/installation.html

That is the page reached when clicking on "Installation guide" in this dialog:

spyder-dialog

1) From the section "Standalone installers", I understand that those are the recommended Win/Mac installation method: Our standalone installers for Windows and macOS are available from Spyder 4.2 onwards. We recommend using this installation method on those platforms, But in section "Updating spyder" I read: If you installed Spyder through Anaconda (recommended) so a reader is confused about which one the recommended method is.

2) The "Updating spyder" section contains instructions for updating the app when package managers and pip were used for the initial installation. There is nothing concerning the update when a standalone installer was used. In that section, I would expect to read how I should proceed in the latter case: should I first uninstall spyder? Can I just run the installer of the new version?

Regards

ccordoba12 commented 3 years ago

Hey @thistlillo, thanks a lot for your remarks! Is it ok for you to open a pull request to improve the things you mentioned? It'd be really helpful but there's no problem if you don't feel comfortable with that.

thistlillo commented 3 years ago

Hello @ccordoba12, opening a pull request would not be a problem (indeed, I would love to contribute, even if with a less than minimal help), but I would not be able to modify the instructions. I do not know for certain:

juanis2112 commented 3 years ago

Hi @thistlillo. We are happy to help you get the right information to contribute.

You need to make the changes in the branch 4.x and master since the latter is the one that points to the Spyder 5 documentation. @ccordoba12 please correct me if I'm wrong and let us know if I missed something important.

Please let me know if you have any other questions of if you need any help with the PR. I will review it once you have it ready. :)

juanis2112 commented 3 years ago

@thistlillo please let me know before Saturday if you will be doing the PR so we can wait for you. Otherwise I'll work on it next week :)

thistlillo commented 3 years ago

I confirm. I can work on it next week, starting from Wednesday (several deadlines in the meantime).

CAM-Gerlach commented 3 years ago

We really appreciate your offer of help, @thistlillo . FYI, updating the "Updating Spyder" section has been one of the issues documented to be improved as part of #201 for some time now, and the basic content needed is discussed there, but unfortunately I hadn't yet found the time to actually add it. If you'd like to help address that aspect in this separate issue, you are free to use the information there, and we can review and guide you along the way.

thistlillo commented 3 years ago

Thank you, @CAM-Gerlach. I have read the discussion you cited and will certainly include all of the comments in what I will propose.

thistlillo commented 3 years ago

Ok, so I am branching out the repository for the updates to the docs. I am about to clone this:

then, after you approve the merge, I will add the instructions to the current master. Is it ok for you?