docs: add Windows setup guide for beginners in README#34755
docs: add Windows setup guide for beginners in README#34755Prasad-JB wants to merge 1 commit intoapache:masterfrom
Conversation
|
This looks somehow incomplete. I'm also not sure if it should be in the readme, where it might make more sense under a new "Windows Tips" section in the "Installation" section of the docs site? |
|
Thanks for the feedback, @rusackas Would you prefer that approach? If yes, I’ll update the PR accordingly. |
|
Hello @Prasad-JB, thanks for contributing to Superset. It's unclear what problem this is trying to solve. I don't think we want any documentation related to setting up a dev environment for Windows contributors; if a Windows user wants to contribute to the codebase they'll need to figure it out. I think it would be reasonable to add a question to the FAQ "How can I deploy Superset on Windows?" with the answer being that Windows is not officially supported. The best way is probably to install WSL2 and run Superset containers following the What do you think? Feel free to reply with what problem you are trying to solve. |
sfirke
left a comment
There was a problem hiding this comment.
Unclear what problem this is trying to solve. Consider making an addition to the FAQ about deploying Superset on Windows or explaining what the goal is here.
|
Looks like the CI run was auto-canceled since a newer check for this PR was already running. Totally normal-nothing wrong with the PR itself. |
|
|
||
| ## Quick Start for Beginners(Windows Friendly) | ||
|
|
||
| Many new contributors face issues while setting up Superset on Windows. | ||
| Here’s a step-by-step guide: | ||
|
|
||
| ### 1. Install Git | ||
| - [Download Git](https://git-scm.com/downloads) | ||
| - Verify installation: | ||
| ```bash | ||
| git --version |
There was a problem hiding this comment.
Is this the whole setup guide? If it is this is incomplete.
|
Thanks for the feedback, @sfirke and @msyavuz. The goal of this guide is to help beginners who face issues setting up Superset on Windows, especially around virtualenv, dependencies, and CLI. I understand Windows isn’t officially supported, so I can either: Move the guide under a “Windows Tips” section in the docs and link it from the README, "or" Add a FAQ entry noting that Windows isn’t officially supported and recommend using WSL2 + Docker Compose. Which approach would you prefer? I want to align with the project’s documentation guidelines. |
|
This is likely AI spam. See numfocus/getting-started-with-open-source#37 (comment) |
|
Thanks for connecting the dots @jbrockmendel |
|
Thanks everyone for the feedback. I now understand that Superset does not officially support Windows development environments, and that adding setup steps in the README could give the wrong impression. To still help new contributors and users who try on Windows, I’d like to reframe this contribution into a FAQ entry: Q: Can I run Superset on Windows? Would this direction make sense? If yes, I’ll open a new PR that adds this entry under the FAQ section of the docs. Thanks again for the guidance! |
This PR adds a Windows-friendly setup guide to README.md.
Many beginners face issues with virtualenv, dependencies, and Superset CLI on Windows.
This guide makes it easier for first-time contributors.