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

Docs: Add windows docker installation instruction #2821

Merged

Conversation

ykchong45
Copy link
Contributor

Problem

Windows WSL has problems working with Docker, especially when it comes to tasks like watching file changes and hot reloading JS files. A recommended approach for development is to clone the project to the WSL file system. However, documentation for this process is currently unavailable.

Solution

Instructions for Windows user are added to the documentation:

  1. Add an info block under Development Documentation > Server development > Clone listenbrainz-server.
  2. Add a new page under Development Documentation > Troubleshooting that contains detailed instructions for Windows Docker Installations.
  3. Add a Link from info block in step 1 and the new page in step 2 using a :ref:.

Copy link
Contributor

@MonkeyDo MonkeyDo left a comment

Choose a reason for hiding this comment

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

Some small typos but apart from that I think this can be merged

docs/developers/devel-env.rst Outdated Show resolved Hide resolved
docs/developers/devel-env.rst Outdated Show resolved Hide resolved
@MonkeyDo MonkeyDo merged commit 907637d into metabrainz:master Apr 8, 2024
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

Successfully merging this pull request may close these issues.

3 participants