Skip to content

docs: add Windows setup guide for beginners in README#34755

Closed
Prasad-JB wants to merge 1 commit intoapache:masterfrom
Prasad-JB:docs/windows-setup-guide
Closed

docs: add Windows setup guide for beginners in README#34755
Prasad-JB wants to merge 1 commit intoapache:masterfrom
Prasad-JB:docs/windows-setup-guide

Conversation

@Prasad-JB
Copy link

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.

@dosubot dosubot bot added doc Namespace | Anything related to documentation windows labels Aug 19, 2025
@sadpandajoe sadpandajoe requested a review from sfirke August 19, 2025 17:20
@rusackas
Copy link
Member

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?

@Prasad-JB
Copy link
Author

Thanks for the feedback, @rusackas
I understand your point—README might not be the best place for detailed Windows instructions. I can move this guide under the Installation → Windows Tips section in the docs, and then add just a short note/link in the README for visibility.

Would you prefer that approach? If yes, I’ll update the PR accordingly.

@sfirke
Copy link
Member

sfirke commented Aug 20, 2025

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 docker compose instructions but users are on their own for setting up and maintaining WSL2.

What do you think? Feel free to reply with what problem you are trying to solve.

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Prasad-JB
Copy link
Author

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.

Comment on lines +224 to +234

## 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the whole setup guide? If it is this is incomplete.

@Prasad-JB
Copy link
Author

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.

@jbrockmendel
Copy link

This is likely AI spam. See numfocus/getting-started-with-open-source#37 (comment)

@sfirke sfirke closed this Aug 24, 2025
@sfirke
Copy link
Member

sfirke commented Aug 24, 2025

Thanks for connecting the dots @jbrockmendel

@Prasad-JB
Copy link
Author

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?
A: Windows is not officially supported. The recommended approach is to use WSL2 and follow the existing Docker Compose setup instructions. Advanced users can attempt native setup, but it may cause issues and won’t be supported by the community.

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Namespace | Anything related to documentation size/S windows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants