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

Add conda install/setup instructions #169

Merged
merged 24 commits into from
Mar 15, 2024
Merged

Conversation

sjspielman
Copy link
Member

@sjspielman sjspielman commented Mar 13, 2024

Which issue does this address?

Closes #122

Briefly describe the scope of the added docs file, including whether you link out to any external docs.

This file adds conda installation and setup instructions. I open with some short descriptions of what conda is and why we want to use it, with short sentences, lots of spacing, and ample bullets!

Some of it is a bit different from CONTRIBUTING since, as discussed with @jashapiro, the behavior in those commands turns out to not exactly be what we want. The steps included here reflect our separate conversation.
Because of this change, steps for mac/pc are now more similar than they otherwise might have been since interaction with terminal+conda prompt will look about the same. Therefore, I only have 1 setup section here.

Will you need additional visual aids for these docs?

Yes - we will need some Windows screenshots. I plan to open a separate issue to circle back to this later once we get our hands on a PC. Related, there is also a spot where I need to explain how to open the conda prompt, which will also happen once we get that PC.

Any other comments for reviewers?

  • I'm requesting review from @jashapiro for content, and @dvenprasad for feedback on whether I've provided the right kind of information for a conda newcomer to feel comfortable.
  • I wonder if we want an additional section at the bottom for more advanced users and if so what that section might contain besides "make sure you have these three packages installed"
  • Note the info note! Do we need it? What should go in it? The text I have there is of course a placeholder.
  • Edit - is "bucket" too jargony? I figured they will have to encounter this term but maybe I am wrong!

Author checklist

Reviewer checklist

Please refer to the docs style guide while reviewing this pull request.

Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I suggested a few smallish changes.

I think if we are going to introduce people to the Terminal app for the first time, we probably want to do that on a separate page, with more context. Maybe a link here out to a tutorial for command line beginners? Not necessarily our own.

docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
Comment on lines 40 to 43
To launch Terminal, search for "terminal" in spotlight and open the application.
<figure markdown="span">
![Launch the Terminal application.](../../img/terminal-spotlight.png){width="425"}
</figure>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we need these instructions? If somebody is coming in never having used the terminal, diving into conda may not be the best place to start.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If somebody is coming in never having used the terminal, diving into conda may not be the best place to start.

truer words have not been said

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've replaced this with a STUB_LINK to a TBD docs page about "what is the terminal"

docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
@sjspielman
Copy link
Member Author

I think if we are going to introduce people to the Terminal app for the first time, we probably want to do that on a separate page, with more context. Maybe a link here out to a tutorial for command line beginners?

I think this might tie in well with some of the discussion in this PR - #36. What do you think?

Apple actually has some decent docs -

Curious what you think of some of these -

Copy link
Member

@dvenprasad dvenprasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just had one comment about the note admonishment. Otherwise all else looks good!

Please DO SOMETHING TO GET HELP? IS IT OPEN A DISCUSSION? IS IT DM US? IS IT SEE OTHER DOCS FOR WAYS TO GET HELP?
OR DO WE NOT EVEN NEED THIS NOTE?

!!! note
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two admonishments one after the other is too much. The note doesn't really need to be in the box. It can go after the code block. It can be bolded at the most.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the feedback!! I'm very happy to hear overall that the page was (presumably) approachable!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it was approachable, uses the right terms for the right OS ✔️ , easy to follow steps ✔️

Oh oH! this might be a nice to have - maybe a "success" screenshot.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was thinking that. I also was thinking we might want to show a screenshot of the "good expected" output that conda spits out while it's working. Thoughts?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI I made the info bullets, and I ended up moving the note admon to the next step where it more properly belongs. I also added a "success" screenshot into the next step, since there isn't any specific output for setting the channels

…el install). move the note to package install where it is more appropriate. update the conda download link with more info for mac users
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

The Windows stuff is definitely worth a separate pass. I think we may also want to note somewhere that the primary platform for the project is linux, and not all modules will be guaranteed to work on Windows.

docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
Comment on lines 43 to 49
The application to open depends on your operating system:
- _If you are on a macOS machine_, open the Terminal application.
Please refer to [this documentation](STUB_LINK) about how to open and use the Terminal.

- _If you are on a Windows machine_, open the conda prompt.
To launch the prompt, SOMETHING SOMETHING START MENU.
TODO: Add screenshot.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might replace all of this with maybe just a note (collapsed by default?) for if you are new to the terminal. Maybe something like:

??? info "New to the terminal?"

    If you are new to the terminal, you will probably want to start with a more general introduction. 
    Here are a few we recommend:

    - [How to Use Terminal on a Mac: A Beginner's Guide](https://www.makeuseof.com/tag/beginners-guide-mac-terminal/)
    - ...

I like the makeuseof.com link best of what was there.

I actually don't think we should show Spotlight. I know people who never use Spotlight and would find that even more confusing than just instructions on where to find it in the Applications folder. It is fine to mention it as an option (I know, one way to do it), but the screenshot seems overkill. I might phrase it as "The Terminal application is located in the Utilities subfolder of Applications, or you can get to it by searching for "terminal" in Spotlight or Launchpad.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might replace all of this with maybe just a note (collapsed by default?) for if you are new to the terminal.

I'm not sure how I feel about this re-Windows, because we have to distinguish between the Windows terminal (whatever that is) and conda itself. So, just "open a terminal" won't be enough information for Windows. Am I missing something?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If Windows is the special case, then it will need a callout, but I would put that off until we do some Windows testing, is basically what I am saying.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might replace all of this with maybe just a note

Oh, I thought "all of this" meant both windows and mac, but you just mean mac?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I can tell, it should work on windows in Powershell and cmd.exe, the default prompt: https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html

Copy link
Member

@dvenprasad dvenprasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
🐍 🐍 🐍

@sjspielman
Copy link
Member Author

See here: 3c1c57b

I also included one of the videos I liked

Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the caveat that things might change with windows testing, LGTM.

Comment on lines +46 to +53
If you are new to the terminal, we recommend you start with a general introduction.
Here are a few we resources we suggest:

- macOS
- [How to Use Terminal on a Mac: A Beginner's Guide](https://www.makeuseof.com/tag/beginners-guide-mac-terminal/)
- [Video: Using the Terminal on macOS for beginners](https://www.youtube.com/watch?v=dWFMRp6KtlQ)
- Windows
- PENDING: [Getting Started with Powershell](https://learn.microsoft.com/en-us/powershell/scripting/learn/ps101/01-getting-started?view=powershell-7.4)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see this evolving to move these to a link to another document, but this is good for now.

docs/technical-setup/environment-setup/setup-conda.md Outdated Show resolved Hide resolved
@sjspielman sjspielman merged commit c85cb76 into main Mar 15, 2024
3 checks passed
@sjspielman sjspielman deleted the sjspielman/122-conda-setup branch March 15, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Setting up conda env
3 participants