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 mention of Windows Subsystem for Linux to Windows install documentation #15769

Open
sirredbeard opened this issue Oct 21, 2024 · 1 comment
Labels
docs enhancement An improvement of an existing feature

Comments

@sirredbeard
Copy link

Describe the current behavior

The current installation documentation includes a Windows installation section that references PowerShell, CMD, and conda.

I think it would also be useful to mention that users can leverage Prefect on Windows using Windows Subsystem for Linux (WSL).

However, simply listing Windows Subsystem for Linux alongside PowerShell, CMD, and conda as the documentation is currently written wouldn't flow well with the subsequent section about ensuring the Scripts path is in the PATH envar, because that section is irrelevant to WSL.

image

Before I propose a PR, I wanted to open some discussion with the Prefect team on;

  1. Would Prefect welcome mentioning WSL in this section?
  2. Would Prefect be open to tweaking this section of the documentation to allow the inclusion of WSL to flow naturally?

Describe the proposed behavior

I propose that WSL be included because while Prefect is supported on Windows (which is amazing, thank you for doing that work in Prefect 2.0), a fair number of other Python libraries users may leverage are not, which makes WSL useful.

I additionally propose a tweaked Windows installation section to cover installing Prefect on both Windows native and on Windows Subsystem for Linux.

Before I propose an actual PR, I want to make sure this would be welcome by the maintainers. Thank you.

Example Use

No response

Additional context

No response

@sirredbeard sirredbeard added the enhancement An improvement of an existing feature label Oct 21, 2024
@discdiver
Copy link
Contributor

Thank you @sirredbeard! That contribution would be welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement An improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

3 participants