-
Notifications
You must be signed in to change notification settings - Fork 531
use WSL not cmd.exe for Windows dev, simplify guides #11583
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
Conversation
qqmyers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went through and tried to run everything on my Windows 11 box. After some false starts (using WSL 1, trying to convert from 1 to 2), I was able to get things working. Rather than remove the windows.rst doc, I tried to update it - adding some of the config/settings that seemed to be useful/required for my setup and keeping the note about configuring pgAdmin, etc. Assuming @pdurbin and @lubitchv are OK with changes, I think it's OK to go forward. I'll leave it in Review for now.
|
@qqmyers this is great. Thanks for testing, adding all those details, and approving. I made some small tweaks in 126a761 (please feel free to revert or edit further) and moved this to PR to "ready for QA". @lubitchv you're welcome to propose additional edits as well, of course! A good place to preview the latest changes (the "Windows" page is back!) is https://dataverse-guide--11583.org.readthedocs.build/en/11583/developers/windows.html |
|
I tested this on W11 with WSL2 but I still get the same error than before on the dataverse container: |
|
I usually see that INFO statement about no deployment transformer at QDR - when not using WSL/docker. Is it a problem? |
|
At least for me this container never deploys Dataverse, I thought it was because of this message. When I access to this container I only see the payara welcome page. |
|
I am testing something right now, I will get back once that is done since it is very, very, very... slow |
|
This is amazing! Just a couple of things that I had to do since that I didn't see them mentioned on the guides, probably if someone was using WSL gave it for granted or if these steps are really don't required please let me know:
I had these tools previously installed on my machine, also @qqmyers mentioned to me that cloning the repo inside WSL makes the build infinitely faster, you can use your windows files at c:/blablabla but this will make a build to take something between 10-15 min vs something that is less than a minute. |
|
@jp-tosca can you please add a commit or two to this PR with the extra steps you needed? Thanks! I'm glad you got it working! 🎉 |
|
FWIW: Installing java and mvn are part of the quickstart instructions, so nominally already in the overall instructions - perhaps could be more prominent? Similarly, I already noted that using the WSL file system is faster in the windows guide - again, maybe more emphasis? I think SDKMan is not a requirement - I didn't use it, It's probably a useful tool and I don't care if it gets mentioned - perhaps the section with pgadmin could be expanded to talk about 'other useful tools'? (since you don't need pgadmin). |
…r package installation
Add WSL preparation steps and package installation instructions
|
Thanks for the additions @jp-tosca and @qqmyers! I looked them over and they seem fine. I moved this PR to "ready for QA". @ofahimIQSS we should get you a Windows box to test on. |
|
proofread - no issues found. merging! |

What this PR does / why we need it:
@lubitchv and I sat down with her Windows laptop during the DCM25 hackathon and determined that our docs on Windows development could be greatly simplified. Docker works fine for her under WSL.
Which issue(s) this PR closes:
Special notes for your reviewer:
We didn't test with WSL but Victoria says it works.
Suggestions on how to test this:
Is there a release notes update needed for this change?:
Yes, included.
Additional documentation:
Preview here:
Related discussion: https://dataverse.zulipchat.com/#narrow/channel/375812-containers/topic/Current.20steps.20required.20for.20windows.20development.2E/near/524483611