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

Windows specific getting started instructions #678

Merged
merged 8 commits into from
Jan 21, 2025

Conversation

jacobcook1995
Copy link
Collaborator

Description

This PR adds Windows specific instructions for the "getting started page". This is done using tabs and can be seen here.

Type of change

Documentation improvement

@codecov-commenter
Copy link

codecov-commenter commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.60%. Comparing base (cc2e55c) to head (a87b50e).
Report is 8 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #678   +/-   ##
========================================
  Coverage    94.60%   94.60%           
========================================
  Files           73       73           
  Lines         4800     4800           
========================================
  Hits          4541     4541           
  Misses         259      259           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@sallymatson sallymatson 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 to me !! :)

@davidorme
Copy link
Collaborator

The tabs are very pretty! This is Gitbash only though? Wouldn't windows paths need C:// etc. Can we also extend to the installation process and checking paths work. I realise that is extending the scope of the PR!

@jacobcook1995
Copy link
Collaborator Author

This is all windows powershell (which is default installed right).

I can change the path to be C://path/ rather than path if you think that's clearer (guess it's safe to assume that anyone saving to a drive other than C knows what they are doing)?

@jacobcook1995
Copy link
Collaborator Author

The installation via pip is the same regardless of whether you use powershell or bash, obviously the installation of python differs but I was planning to just send the "How to install python on windows" instructions written by Python (which seems better than trying to write our own).

Where is the "checking paths work" section?

@davidorme
Copy link
Collaborator

Where is the "checking paths work" section?

There isn't one at present, but if a user installs Python and then pip fails or installs VE and then ve_run fails then they need to know how to fix it. Actually I don't know how to fix that latter one! pip should register the entry points but I don't know if the windows path then automatically finds them.

Completely agree on the follow the windows official instructions, but there are details on adding the path that are on that page that we should point at.

@jacobcook1995
Copy link
Collaborator Author

Completely agree on the follow the windows official instructions, but there are details on adding the path that are on that page that we should point at.

Wouldn't they ideally be installing python in a way that doesn't require them to add the path themselves though? (at least for current purposes)

@jacobcook1995
Copy link
Collaborator Author

Where is the "checking paths work" section?

There isn't one at present, but if a user installs Python and then pip fails or installs VE and then ve_run fails then they need to know how to fix it. Actually I don't know how to fix that latter one! pip should register the entry points but I don't know if the windows path then automatically finds them.

Are there obvious common ways that pip could fail to install that we should highlight? I'm just concerned that if we tried to cover all the possibilities this page quickly becomes a "how to avoid common python setup errors" page

@sallymatson
Copy link
Collaborator

I hope adding this about the required python version and rec of pyenv/pyenv-win doesn't start to make this too unweildly. @vgro and I were just going through the installation while trying to run in static mode and found the python versioning a bit of a tricky one, especially for users unfamiliar with python, I think it's important to signpost them a bit.

@sallymatson sallymatson self-requested a review January 21, 2025 11:05
@jacobcook1995 jacobcook1995 merged commit 517b0a3 into develop Jan 21, 2025
13 checks passed
@jacobcook1995 jacobcook1995 deleted the bugfix/add_windows_getting_started branch January 21, 2025 11:33
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.

4 participants