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

Add WSL Setup Guide and Update References in Host and Docker Guides #4903

Open
GautamBytes opened this issue Feb 9, 2025 · 1 comment
Open

Comments

@GautamBytes
Copy link
Contributor

GautamBytes commented Feb 9, 2025

Desired behavior

This issue introduces a new documentation page, docs/local_dev_wsl.md, dedicated to guiding Windows developers through setting up Kolibri Studio using Windows Subsystem for Linux (WSL). The goal is to standardize the development environment for Windows and clearly indicate that developing directly on Windows (without WSL) is not recommended. Additionally, references to this new guide have been added to docs/local_dev_host.md , docs/host_services_setup.md and docs/local_dev_docker.md to ensure contributors are aware of the recommended setup.

Current behavior

Currently, there is no dedicated documentation page for setting up Kolibri Studio on Windows using WSL. The existing guides (docs/local_dev_host.md and docs/local_dev_docker.md) do not explicitly mention the WSL setup. This can lead to Windows developers attempting a native setup, which may result in inconsistent development environments and potential issues.

Value add

Improved Developer Experience: Provides clear, step-by-step instructions for Windows developers to set up a Linux-like development environment using WSL.
Standardization: Ensures that all contributors on Windows follow a consistent, recommended setup that aligns with the overall project development environment.
Reduced Support Overhead: By guiding developers to use WSL, we can help mitigate issues that arise from native Windows setups, leading to fewer support requests related to environment configuration.

Possible tradeoffs

Maintenance: Introducing an additional documentation page increases the documentation maintenance overhead.
Adoption Curve: Developers who are accustomed to a native Windows environment may need time to adapt to using WSL, although the long-term benefits are expected to outweigh this initial adjustment.

Add labels

  • Documentation Enhancement
@MisRob
Copy link
Member

MisRob commented Feb 11, 2025

FYI @GautamBytes opened this issue on my request I made on Slack. Thanks Gautam, we will have a look at your pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants