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.

Sign up for GitHub

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

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
172fc59
add disclaimer about using WSL outside of VM
KadenAgrey Jan 13, 2023
dfb2973
Merge branch 'pantsbuild:main' into docs-getting-started-WSL-disclaimer
KadenAgrey Jan 14, 2023
d6b416b
using wsl on windows disclaimer draft 2
KadenAgrey Jan 14, 2023
b6472f2
capitalize Pants
KadenAgrey Jan 14, 2023
3c937ef
Group disclaimer with windows 10 callout
KadenAgrey Jan 16, 2023
667c4e6
Merge branch 'pantsbuild:main' into docs-getting-started-WSL-disclaimer
KadenAgrey Jan 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/markdown/Getting Started/getting-started/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,7 @@ 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 `.
>
> Projects using Pants must be contained within the Linux virtual machine:
>
> - Navigating a Linux shell to a Windows directory via the `/mnt` directory, or using the `wsl` prefix with a Windows shell in a Windows directory, and executing Pants may result in unexpected behavior.