Skip to content

Conversation

@pdurbin
Copy link
Member

@pdurbin pdurbin commented Jun 17, 2025

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:

  • On a Windows box, install WSL
  • From a WSL shell prompt, run our usual dev quickstart.

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

@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Jun 17, 2025
@github-actions github-actions bot added Component: Containers Anything related to cloudy Dataverse, shipped in containers. Type: Bug a defect labels Jun 17, 2025
@pdurbin pdurbin requested a review from lubitchv June 17, 2025 15:48
@cmbz cmbz added FY25 Sprint 25 FY25 Sprint 25 (2025-06-04 - 2025-06-18) FY25 Sprint 26 FY25 Sprint 26 (2025-06-18 - 2025-07-02) labels Jun 18, 2025
@qqmyers qqmyers moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Jun 20, 2025
@qqmyers qqmyers self-assigned this Jun 20, 2025
@qqmyers qqmyers added the Size: 10 A percentage of a sprint. 7 hours. label Jun 25, 2025
Copy link
Member

@qqmyers qqmyers left a 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.

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jul 1, 2025
@qqmyers qqmyers moved this from Ready for QA ⏩ to In Review 🔎 in IQSS Dataverse Project Jul 1, 2025
@pdurbin pdurbin assigned pdurbin and unassigned qqmyers Jul 1, 2025
@pdurbin pdurbin moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jul 1, 2025
@pdurbin pdurbin removed their assignment Jul 1, 2025
@pdurbin
Copy link
Member Author

pdurbin commented Jul 1, 2025

@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

@coveralls
Copy link

Coverage Status

coverage: 23.211%. remained the same
when pulling e3cba94 on 10606-windows-dev
into 1c31486 on develop.

@cmbz cmbz added the FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) label Jul 2, 2025
@poikilotherm poikilotherm requested a review from jp-tosca July 3, 2025 13:41
@jp-tosca
Copy link
Contributor

jp-tosca commented Jul 3, 2025

I tested this on W11 with WSL2 but I still get the same error than before on the dataverse container:

dev_dataverse> [#|2025-07-03T14:46:49.782+0000|INFO|Payara 6.2025.3|javax.enterprise.system.core|_ThreadID=54;_ThreadName=RunLevelControllerThread-1751553967518;_TimeMillis=1751554009782;_LevelValue=800;|
dev_dataverse>   No deployment transformer implementation found.|#]

@qqmyers
Copy link
Member

qqmyers commented Jul 3, 2025

I usually see that INFO statement about no deployment transformer at QDR - when not using WSL/docker. Is it a problem?

@jp-tosca
Copy link
Contributor

jp-tosca commented Jul 3, 2025

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.

@jp-tosca
Copy link
Contributor

jp-tosca commented Jul 3, 2025

I am testing something right now, I will get back once that is done since it is very, very, very... slow

@jp-tosca
Copy link
Contributor

jp-tosca commented Jul 3, 2025

This is amazing!

image

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 to install SDKMAN (to manage Java).
  • Java 17 (inside WSL)
  • MVN (inside WSL)

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.

@pdurbin @qqmyers thoughts?

@pdurbin pdurbin moved this from Ready for QA ⏩ to In Progress 💻 in IQSS Dataverse Project Jul 3, 2025
@pdurbin
Copy link
Member Author

pdurbin commented Jul 3, 2025

@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! 🎉

@qqmyers
Copy link
Member

qqmyers commented Jul 3, 2025

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).

@pdurbin pdurbin moved this from In Progress 💻 to Ready for QA ⏩ in IQSS Dataverse Project Jul 3, 2025
@pdurbin
Copy link
Member Author

pdurbin commented Jul 3, 2025

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.

@ofahimIQSS ofahimIQSS self-assigned this Jul 8, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Jul 8, 2025
@ofahimIQSS ofahimIQSS removed their assignment Jul 8, 2025
@ofahimIQSS
Copy link
Contributor

proofread - no issues found. merging!

@ofahimIQSS ofahimIQSS merged commit c000317 into develop Jul 8, 2025
8 checks passed
@ofahimIQSS ofahimIQSS deleted the 10606-windows-dev branch July 8, 2025 16:38
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Jul 8, 2025
@pdurbin pdurbin added this to the 6.7 milestone Jul 8, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Jul 9, 2025
@cmbz cmbz added the FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) label Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Containers Anything related to cloudy Dataverse, shipped in containers. FY25 Sprint 25 FY25 Sprint 25 (2025-06-04 - 2025-06-18) FY25 Sprint 26 FY25 Sprint 26 (2025-06-18 - 2025-07-02) FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) Size: 10 A percentage of a sprint. 7 hours. Type: Bug a defect

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Dataverse development in Windows

7 participants