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

Update the documentaton regarding Windows #3029

Merged
merged 3 commits into from
Dec 5, 2023

Conversation

jessica-mitchell
Copy link
Contributor

@jessica-mitchell jessica-mitchell commented Dec 4, 2023

Removing the Windows logo from the installation pages, as requested from users who deem it a bit deceiving, since no official support is available.
Added text stating to use Windows sub system for Linux (known to work) or the docker container.

@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Dec 4, 2023
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Dec 4, 2023
@jessica-mitchell
Copy link
Contributor Author

@pippowell Can you take a look? Pleae comment if you would like to see changes or are ok with this page: https://nest-simulator--3029.org.readthedocs.build/en/3029/installation/user.html#options-for-windows-users

@pippowell
Copy link

pippowell commented Dec 4, 2023

@jessica-mitchell Looks good and the links work. Might could add the windows logo back but with an exclamation point or similar to indicate that you can technically get NEST to work if you have a Windows machine, but that it won't work out-of-the-box on this OS. Then they might not immediately give up when they don't see the logo and actually try to get WSL working. A user perspective that's less important now, when most people using it are committed to making it work and trying it anyway, but could be helpful later for hooking new users who hear about it and want to try but aren't 100% committed upfront.

@jessica-mitchell
Copy link
Contributor Author

With @pippowell approval merging this PR

@jessica-mitchell jessica-mitchell merged commit c61ac02 into nest:master Dec 5, 2023
24 checks passed
Documentation automation moved this from In progress to Done Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants