diff --git a/docs/developers/devel-env.rst b/docs/developers/devel-env.rst index 787e76c0fe..1bf21ee1d6 100644 --- a/docs/developers/devel-env.rst +++ b/docs/developers/devel-env.rst @@ -19,7 +19,12 @@ Clone listenbrainz-server ------------------------- ListenBrainz is hosted on GitHub at https://github.com/metabrainz/listenbrainz-server/. -You can use ``git`` to clone it (or your own fork) to your computer +You can use ``git`` to clone it (or your own fork) to your computer. + +.. note:: + Windows users are advised to clone the repository in their WSL2 file system to avoid code watcher issues. + Please refer to :ref:`run docker inside WSL ` for more + information. .. code-block:: bash diff --git a/docs/developers/troubleshooting.rst b/docs/developers/troubleshooting.rst new file mode 100644 index 0000000000..167e62d229 --- /dev/null +++ b/docs/developers/troubleshooting.rst @@ -0,0 +1,29 @@ +=============== +Troubleshooting +=============== + +Docker Installations +-------------------- + +.. _Windows Docker Installation: + +Windows +^^^^^^^ + +If changes to JS files are not being watched or hot reloaded by the host file system, follow +these steps: + +1. Clone or move the project into your WSL2 file system. + +2. Create a ``.wslconfig`` file under ``C:/Users//`` with the following content: + +.. code-block:: bash + + [wsl2] + localhostforwarding=true + +3. To apply the changes, you may need to shut down the WSL 2 VM by running ``wsl --shutdown`` in +the command prompt. Then, restart your WSL instance. + +For more detailed information, refer to the `wsl settings page +`_. diff --git a/docs/index.rst b/docs/index.rst index 63220daaf3..fe07413bf2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,6 +43,7 @@ Contents developers/spark-architecture developers/mapping developers/commands + developers/troubleshooting .. toctree:: :maxdepth: 2