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

WSL disclaimer in Getting Started/Prerequisites #18000

Merged
merged 6 commits into from
Jan 17, 2023
Merged

WSL disclaimer in Getting Started/Prerequisites #18000

merged 6 commits into from
Jan 17, 2023

Conversation

KadenAgrey
Copy link
Contributor

A short disclaimer was added to inform new Windows users that their projects must live within the Linux virtual machine for Pants to work correctly.

Feedback welcome! In particular, I want to confirm that using the wsl prefix in a Windows shell has the same limitations. I will check myself in a few days if no one knows already.

Related to discussion in #17986.

Copy link
Contributor

@benjyw benjyw left a comment

Choose a reason for hiding this comment

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

Thanks for updating the docs!

@@ -68,3 +68,9 @@ System-specific notes
> - Install a recent Linux distribution under WSL 2 (we have tested with Ubuntu 20.04 LTS).
> - Run `sudo apt install unzip python3-dev python3-distutils python3-venv gcc` in the distribution.
> - You can then run Pants commands in a Linux shell, or in a Windows shell by prefixing with `wsl `.

> 🚧 Using WSL on Windows
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we already have a callout for Windows, I think it's sufficient if we add this as another bullet point above?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree! Will make the change

Copy link
Contributor

@benjyw benjyw left a comment

Choose a reason for hiding this comment

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

Thanks!

@benjyw
Copy link
Contributor

benjyw commented Jan 16, 2023

@KadenAgrey can you merge latest main and push? Something is awry with our change classifier, normally a docs-only change would not trigger all those CI jobs.

@jsirois jsirois merged commit 44ccb3f into pantsbuild:main Jan 17, 2023
@jsirois
Copy link
Contributor

jsirois commented Jan 17, 2023

Thanks @KadenAgrey

@KadenAgrey KadenAgrey deleted the docs-getting-started-WSL-disclaimer branch January 21, 2023 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants