Update getting started guide #122
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make it impossible to blindly copy and paste the wrong download command for your OS Simplify the instructions for the case where you install directly from a URL Explain the purpose of the different options available under "assets"
github-actions
bot
added
the
documentation
zacharyburnett
approved these changes
Nov 15, 2023
Co-authored-by: Zach Burnett <zachary.r.burnett@gmail.com>
|
Great, thanks for your suggestions! I have accepted all of them so this should be ready to merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I helped walk a student through this process today. There were points where a tempting copy-and-paste-able command did not apply to their system (i.e. it was for macOS and not Linux, and it didn't point to the latest version). I think any command that looks like it can be copied and pasted unmodified eventually will be, so I changed the steps to be the "shortcut" path of just giving a URL to conda and letting it go. The Readthedocs theme also cuts off the end of the commands and it's not always obvious the box will scroll, so the student was missing that
--namewas an important option to include.Happy to iterate on this if you're not happy with it as written or explain my changes further if you want. Just trying to smooth over some bumps in the road I noticed with them earlier today.
Maybe some day there will be a redirect URL so you can just say
conda env create -n stenv --file https://stsci.edu/stenv/macor something 😃