Skip to content

Simplify copy on Install page #669

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

Merged
merged 17 commits into from
Jan 19, 2022
Merged

Simplify copy on Install page #669

merged 17 commits into from
Jan 19, 2022

Conversation

palewire
Copy link
Collaborator

No description provided.

@palewire palewire added this to the Streamline the site milestone Jan 18, 2022
@palewire palewire requested a review from choldgraf January 18, 2022 04:31
@palewire
Copy link
Collaborator Author

Once we settle this one, @choldgraf, I think I'm prepared to end my War on Cruft.

Copy link
Collaborator

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

I think this is generally an improvement, but I'm worried that we're putting too much information in front of people we're assuming are total beginners. As a general rule, I think tutorials are best if they can be exactly followed from top to bottom with just copy-pasting. I'd rather we recommend a single option for people to type in, and then provide links for other options/more information if they want to dig deeper.

So, I've updated a few of the lines here to recommend the use of pip and moved mentions of conda/mamba/pipenv to asides. What do you think about that?

palewire and others added 7 commits January 18, 2022 16:44
Co-authored-by: Chris Holdgraf <[email protected]>
Co-authored-by: Chris Holdgraf <[email protected]>
Co-authored-by: Chris Holdgraf <[email protected]>
Co-authored-by: Chris Holdgraf <[email protected]>
Co-authored-by: Chris Holdgraf <[email protected]>
Co-authored-by: Chris Holdgraf <[email protected]>
@palewire
Copy link
Collaborator Author

A made a bunch of trims in line with your suggestions. Have another look.

Copy link
Collaborator

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

This looks good to me - I think it's much simpler, but for "total beginner install docs", I think that's a good thing :-)

@palewire palewire merged commit c165278 into master Jan 19, 2022
@krassowski krassowski deleted the install-copy branch May 26, 2024 10:18
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.

2 participants